diff options
| author | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-11-28 23:56:20 +0100 |
|---|---|---|
| committer | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-11-28 23:56:20 +0100 |
| commit | bbf9ccff80c86abd7dad56c5ac29de4a4abe40ce (patch) | |
| tree | b0d8387abb44d8a7c1ac5576325a0b320eb81e83 /docs/conf.py | |
| parent | cdf0c71bcc07966ff131bfca83a3131c7e41f202 (diff) | |
| download | jsonschema-bbf9ccff80c86abd7dad56c5ac29de4a4abe40ce.tar.gz | |
Use only ``autodoc`` to generate the API documentation
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 31 |
1 files changed, 3 insertions, 28 deletions
diff --git a/docs/conf.py b/docs/conf.py index 0e4bc6c..595cdf6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,15 +36,15 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.viewcode", - - "autoapi.extension", - "sphinx_autodoc_typehints", "sphinx_copybutton", "sphinx_json_schema_spec", "sphinxcontrib.spelling", "sphinxext.opengraph", ] +# Add typing annotations to signatures +autodoc_typehints = "signature" + cache_path = "_cache" # Add any paths that contain templates here, relative to this directory. @@ -159,28 +159,3 @@ autosectionlabel_prefix_document = True # -- Options for sphinxcontrib-spelling ----------------------------------- spelling_word_list_filename = "spelling-wordlist.txt" - -# -- Options for autoapi ---------------------------------------------------- - -suppress_warnings = [ - "autoapi.python_import_resolution", - "autoapi.toc_reference", - "epub.duplicated_toc_entry", -] -autoapi_root = "api" -autoapi_ignore = [ - "*/_[a-z]*.py", - "*/__main__.py", - "*/benchmarks/*", - "*/cli.py", - "*/tests/*", -] -autoapi_options = [ - "members", - "undoc-members", - "show-module-summary", - "imported-members", -] - -autoapi_type = "python" -autoapi_dirs = [PACKAGE_SRC] |