Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ tests/ports/unix/ffi_lib.so
# Python cache files
__pycache__/

# Compiled translation files
docs/**/*.mo

# Customized Makefile/project overrides
GNUmakefile
user.props
Expand Down
168 changes: 89 additions & 79 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,16 @@
#
# We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"
# breakdown, so use the same version identifier for both to avoid confusion.
version = release = '1.26'
version = release = "1.26"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# -- Options for i18n output ----------------------------------------------
locale_dirs = ["locale"]
gettext_compact = False

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
Expand All @@ -93,81 +97,88 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['build', '.venv', "esp32", "esp8266", "pyboard", "wipy",
"develop/cmodules.rst",
"develop/compiler.rst",
"develop/extendingmicropython.rst",
"develop/gettingstarted.rst",
"develop/index.rst",
"develop/library.rst",
"develop/maps.rst",
"develop/memorymgt.rst",
"develop/natmod.rst",
"develop/optimizations.rst",
"develop/porting.rst",
"develop/publiccapi.rst",
"develop/qstr.rst",
"develop/writingtests.rst",
"library/btree.rst",
"library/esp.rst",
"library/espnow.rst",
"library/esp32.rst",
"library/framebuf.rst",
"library/rp2.rst",
"library/rp2.DMA.rst",
"library/rp2.Flash.rst",
"library/rp2.PIO.rst",
"library/rp2.StateMachine.rst",
"library/wm8960.rst",
"library/zephyr.rst",
"library/zephyr.DiskAccess.rst",
"library/zephyr.FlashArea.rst",
"library/zephyr.zsensor.rst",
"library/lcd160cr.rst",
"library/machine.ADCWiPy.rst",
"library/machine.Counter.rst",
"library/machine.Encoder.rst",
"library/machine.SD.rst",
"library/machine.SDCard.rst",
"library/machine.TimerWiPy.rst",
"library/machine.USBDevice.rst",
"library/network.CC3K.rst",
"library/network.WIZNET5K.rst",
"library/network.WLANWiPy.rst",
"library/neopixel.rst",
"library/pyb.Accel.rst",
"library/pyb.LCD.rst",
"library/pyb.Switch.rst",
"library/wipy.rst",
"mimxrt/general.rst",
"mimxrt/pinout.rst",
"mimxrt/tutorial/intro.rst",
"mimxrt/quickref.rst",
"renesas-ra/general.rst",
"renesas-ra/quickref.rst",
"renesas-ra/tutorial/index.rst",
"renesas-ra/tutorial/intro.rst",
"renesas-ra/tutorial/program_in_flash.rst",
"renesas-ra/tutorial/reset.rst",
"renesas-ra/tutorial/troubleshooting.rst",
"renesas-ra/tutorial/using_peripheral.rst",
"rp2/general.rst",
"rp2/quickref.rst",
"rp2/tutorial/intro.rst",
"rp2/tutorial/pio.rst",
"rp2/tutorial/reset.rst",
"samd/general.rst",
"samd/quickref.rst",
"samd/pinout.rst",
"samd/tutorial/intro.rst",
"unix/quickref.rst",
"zephyr/general.rst",
"zephyr/quickref.rst",
"zephyr/tutorial/index.rst",
"zephyr/tutorial/intro.rst",
"zephyr/tutorial/pins.rst",
"zephyr/tutorial/repl.rst",
"zephyr/tutorial/storage.rst"]
exclude_patterns = [
"build",
".venv",
"esp32",
"esp8266",
"pyboard",
"wipy",
"develop/cmodules.rst",
"develop/compiler.rst",
"develop/extendingmicropython.rst",
"develop/gettingstarted.rst",
"develop/index.rst",
"develop/library.rst",
"develop/maps.rst",
"develop/memorymgt.rst",
"develop/natmod.rst",
"develop/optimizations.rst",
"develop/porting.rst",
"develop/publiccapi.rst",
"develop/qstr.rst",
"develop/writingtests.rst",
"library/btree.rst",
"library/esp.rst",
"library/espnow.rst",
"library/esp32.rst",
"library/framebuf.rst",
"library/rp2.rst",
"library/rp2.DMA.rst",
"library/rp2.Flash.rst",
"library/rp2.PIO.rst",
"library/rp2.StateMachine.rst",
"library/wm8960.rst",
"library/zephyr.rst",
"library/zephyr.DiskAccess.rst",
"library/zephyr.FlashArea.rst",
"library/zephyr.zsensor.rst",
"library/lcd160cr.rst",
"library/machine.ADCWiPy.rst",
"library/machine.Counter.rst",
"library/machine.Encoder.rst",
"library/machine.SD.rst",
"library/machine.SDCard.rst",
"library/machine.TimerWiPy.rst",
"library/machine.USBDevice.rst",
"library/network.CC3K.rst",
"library/network.WIZNET5K.rst",
"library/network.WLANWiPy.rst",
"library/neopixel.rst",
"library/pyb.Accel.rst",
"library/pyb.LCD.rst",
"library/pyb.Switch.rst",
"library/wipy.rst",
"mimxrt/general.rst",
"mimxrt/pinout.rst",
"mimxrt/tutorial/intro.rst",
"mimxrt/quickref.rst",
"renesas-ra/general.rst",
"renesas-ra/quickref.rst",
"renesas-ra/tutorial/index.rst",
"renesas-ra/tutorial/intro.rst",
"renesas-ra/tutorial/program_in_flash.rst",
"renesas-ra/tutorial/reset.rst",
"renesas-ra/tutorial/troubleshooting.rst",
"renesas-ra/tutorial/using_peripheral.rst",
"rp2/general.rst",
"rp2/quickref.rst",
"rp2/tutorial/intro.rst",
"rp2/tutorial/pio.rst",
"rp2/tutorial/reset.rst",
"samd/general.rst",
"samd/quickref.rst",
"samd/pinout.rst",
"samd/tutorial/intro.rst",
"unix/quickref.rst",
"zephyr/general.rst",
"zephyr/quickref.rst",
"zephyr/tutorial/index.rst",
"zephyr/tutorial/intro.rst",
"zephyr/tutorial/pins.rst",
"zephyr/tutorial/repl.rst",
"zephyr/tutorial/storage.rst",
]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down Expand Up @@ -210,7 +221,6 @@
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
except:
html_theme = "default"
html_theme_path = ["."]
Expand All @@ -234,12 +244,12 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '../../openmv-media/logos/openmv-logo-white/web-logo-sticky.png'
html_logo = "../../openmv-media/logos/openmv-logo-white/web-logo-sticky.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '../../openmv-media/icons/openmv-icon/openmv.ico'
html_favicon = "../../openmv-media/icons/openmv-icon/openmv.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
Loading