Skip to content

Commit 43414d9

Browse files
committed
docs(conf): Add autoapi config
1 parent 8c64fbf commit 43414d9

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
@@ -22,6 +22,7 @@
2222

2323
extensions = [
2424
"sphinx.ext.autodoc",
25+
"autoapi.extension",
2526
"sphinx.ext.intersphinx",
2627
"sphinx_autodoc_typehints",
2728
"sphinx.ext.todo",
@@ -96,6 +97,12 @@
9697
ogp_desscription_length = about["__description__"]
9798
ogp_site_name = about["__title__"]
9899

100+
# sphinx-autoapi
101+
autoapi_type = "python"
102+
autoapi_dirs = [project_root / "libtmux"]
103+
autoapi_generate_api_docs = False # when fales, use directives
104+
suppress_warnings = ["autoapi.python_import_resolution", "autoapi.not_readable"]
105+
99106
# sphinx-copybutton
100107
copybutton_prompt_text = (
101108
r">>> |\.\.\. |> |\$ |\# | In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "

0 commit comments

Comments
 (0)