diff options
| author | Scott Shawcroft <scott@adafruit.com> | 2020-05-15 10:31:05 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-15 10:31:05 -0700 |
| commit | 0d8bca92e208e705150097d26db6a5390dc9eb9b (patch) | |
| tree | 122acb729c3e0e629642bc39f7f2ee9db3fc084a /conf.py | |
| parent | bd78ab3c2812f7772021be7863f89a9650589d80 (diff) | |
| parent | 8ac3e7977f87219454dbab50264a723e797b877a (diff) | |
Merge pull request #2810 from dherrada/master
Pyi integration
Diffstat (limited to 'conf.py')
| -rw-r--r-- | conf.py | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -55,7 +55,6 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'rstjinja', - 'c2rst', 'recommonmark', ] @@ -66,9 +65,18 @@ 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 = [os.path.join('circuitpython-stubs', x) for x in os.listdir('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' +autoapi_python_use_implicit_namespaces = True # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -78,7 +86,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 +113,7 @@ exclude_patterns = ["**/build*", ".git", ".venv", ".direnv", + "docs/autoapi", "docs/README.md", "drivers", "examples", |
