summaryrefslogtreecommitdiff
path: root/conf.py
diff options
context:
space:
mode:
authorScott Shawcroft <scott@tannewt.org>2020-05-12 17:15:28 -0700
committerScott Shawcroft <scott@tannewt.org>2020-05-12 17:28:24 -0700
commit4e8de3c554024d3ac89e9ee77b958a6932a64bec (patch)
tree4606c0cf69cef8a033aa2d95fab0811ddf49123a /conf.py
parentc534a872a2b5a2d5e6b7543f56539afb24261443 (diff)
Swap sphinx to autoapi and the inline stubs
Diffstat (limited to 'conf.py')
-rw-r--r--conf.py14
1 files changed, 11 insertions, 3 deletions
diff --git a/conf.py b/conf.py
index 2e503737c..aea84dd21 100644
--- a/conf.py
+++ b/conf.py
@@ -55,7 +55,6 @@ extensions = [
'sphinx.ext.todo',
'sphinx.ext.coverage',
'rstjinja',
- 'c2rst',
'recommonmark',
]
@@ -66,9 +65,17 @@ templates_path = ['templates']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
- '.c': ''
}
+extensions.append('autoapi.extension')
+
+autoapi_type = 'python'
+# Uncomment this if debugging autoapi
+# autoapi_keep_files = True
+autoapi_dirs = ['circuitpython-stubs']
+autoapi_add_toctree_entry = False
+autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance', 'special-members', 'show-module-summary']
+autoapi_template_dir = 'docs/autoapi/templates'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
@@ -78,7 +85,7 @@ source_suffix = {
# General information about the project.
project = 'Adafruit CircuitPython'
-copyright = '2014-2018, MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)'
+copyright = '2014-2020, MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)'
# These are overwritten on ReadTheDocs.
# The version info for the project you're documenting, acts as replacement for
@@ -105,6 +112,7 @@ exclude_patterns = ["**/build*",
".git",
".venv",
".direnv",
+ "docs/autoapi",
"docs/README.md",
"drivers",
"examples",