File tree Expand file tree Collapse file tree 3 files changed +29
-207
lines changed Expand file tree Collapse file tree 3 files changed +29
-207
lines changed Original file line number Diff line number Diff line change 17
17
18
18
extensions = [
19
19
"sphinx.ext.autodoc" ,
20
- "autoapi.extension" ,
21
20
"sphinx.ext.intersphinx" ,
22
21
"sphinx_autodoc_typehints" ,
23
22
"sphinx.ext.todo" ,
24
23
"sphinx.ext.napoleon" ,
25
24
"sphinx.ext.linkcode" ,
26
- "sphinx_autoissues" ,
27
25
"sphinx_click.ext" , # sphinx-click
28
26
"sphinx_inline_tabs" ,
29
27
"sphinx_copybutton" ,
30
28
"sphinxext.opengraph" ,
31
29
"sphinxext.rediraffe" ,
32
30
"myst_parser" ,
31
+ "sphinx_toctree_autodoc_fix" ,
32
+ "linkify_issues" ,
33
+ ]
34
+ myst_enable_extensions = [
35
+ "colon_fence" ,
36
+ "substitution" ,
37
+ "replacements" ,
38
+ "strikethrough" ,
33
39
]
34
- myst_enable_extensions = ["colon_fence" , "substitution" , "replacements" ]
35
40
36
41
templates_path = ["_templates" ]
37
42
83
88
]
84
89
}
85
90
86
- # sphinx-autoissues
87
- issuetracker = "github"
88
- issuetracker_project = "vcs-python/vcspull"
91
+ # linkify_issues
92
+ issue_url_tpl = "https://github.com/tony/vcs-python/vcspull/issues/{issue_id}"
89
93
90
94
# sphinx.ext.autodoc
91
95
autoclass_content = "both"
92
96
autodoc_member_order = "bysource"
93
- autosummary_generate = True
94
97
95
98
# sphinx-autodoc-typehints
96
99
autodoc_typehints = "description" # show type hints in doc body instead of signature
97
100
simplify_optional_unions = True
98
101
99
- # sphinx-autoapi
100
- autoapi_type = "python"
101
- autoapi_dirs = [project_root / "vcspull" ]
102
- autoapi_generate_api_docs = False # when fales, use directives
103
- suppress_warnings = ["autoapi.python_import_resolution" , "autoapi.not_readable" ]
104
-
105
102
# sphinx.ext.napoleon
106
103
napoleon_google_docstring = True
107
104
napoleon_include_init_with_doc = True
You can’t perform that action at this time.
0 commit comments