Skip to content

Commit 58488ba

Browse files
committed
docs(conf): Add sphinx-autoapi
1 parent dff408f commit 58488ba

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
extensions = [
2323
"sphinx.ext.autodoc",
24+
"autoapi.extension",
2425
"sphinx.ext.autosummary",
2526
"sphinx_autodoc_typehints",
2627
"sphinx.ext.intersphinx",
@@ -95,6 +96,12 @@ def setup(app):
9596
autodoc_member_order = "bysource"
9697
autosummary_generate = True
9798

99+
# sphinx-autoapi
100+
autoapi_type = "python"
101+
autoapi_dirs = [project_root / "libvcs"]
102+
autoapi_generate_api_docs = False # when fales, use directives
103+
suppress_warnings = ["autoapi"]
104+
98105
# sphinxext.opengraph
99106
ogp_site_url = about["__docs__"]
100107
ogp_image = "_static/img/icons/icon-192x192.png"

0 commit comments

Comments
 (0)