# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio", "terminalio"]
-
+# autodoc_mock_imports = ["digitalio", "busio"]
intersphinx_mapping = {
- "python": ("https://docs.python.org/3.4", None),
+ "python": ("https://docs.python.org/3.7", None),
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
}
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
#
add_function_parentheses = True
+# Generate the class documentation from both the class docstring and the __init__ docstring
+autoclass_content = "both"
+
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
#
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-if not on_rtd: # only import and set the theme if we're building docs locally
- try:
- 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 = ["."]
-else:
- html_theme_path = ["."]
+html_theme = "sphinx_rtd_theme"
# 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,