Commit 5e1fdd5 1 parent d8ff8cd commit 5e1fdd5 Copy full SHA for 5e1fdd5
File tree 5 files changed +16
-123
lines changed
sphinx_toctree_autodoc_fix
5 files changed +16
-123
lines changed Original file line number Diff line number Diff line change @@ -134,21 +134,23 @@ See more: <https://gp-libs.git-pull.com/linkify_issues/>
134
134
135
135
### Table of contents for autodoc
136
136
137
- ` sphinx.ext.autodoc ` doesn't link objects in the table of contents. So we need a
138
- plugin to help.
137
+ Removed in v0.0.1a12.
139
138
140
- See more: < https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/ >
139
+ [ Sphinx 5.2 ] ( https://pypi.org/project/Sphinx/5.2.0 ) bakes this in by default:
141
140
142
- #### Configuration
141
+ Settings options:
143
142
144
- 1 . Add ` 'sphinx_toctree_autodoc_fix' ` to ` extensions `
143
+ - ` add_function_parentheses = False ` (default: ` True ` )
144
+ - ` toc_object_entries_show_parents ` can be (default: ` 'domain' ` ):
145
+ - ` toc_object_entries_show_parents = 'domain' `
146
+ - ` toc_object_entries_show_parents = 'hide' `
147
+ - ` toc_object_entries_show_parents = 'all' `
145
148
146
- ``` python
147
- extensions = [
148
- # ...
149
- " sphinx_toctree_autodoc_fix" ,
150
- ]
151
- ```
149
+ See also:
150
+
151
+ - https://github.com/sphinx-doc/sphinx/issues/6316
152
+ - https://github.com/sphinx-doc/sphinx/pull/10807
153
+ - https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f
152
154
153
155
## Install
154
156
Original file line number Diff line number Diff line change 35
35
"sphinxext.rediraffe" ,
36
36
"myst_parser" ,
37
37
"linkify_issues" ,
38
- "sphinx_toctree_autodoc_fix" ,
39
38
]
40
39
myst_enable_extensions = [
41
40
"colon_fence" ,
94
93
]
95
94
}
96
95
96
+ # sphinx.ext.autoapi
97
+ toc_object_entries_show_parents = "hide"
98
+
97
99
# linkify_issues
98
100
issue_url_tpl = f'{ about ["__github__" ]} /issues/{{issue_id}}'
99
101
Original file line number Diff line number Diff line change 9
9
10
10
quickstart
11
11
doctest/index
12
- sphinx_toctree_autodoc_fix/index
13
12
linkify_issues/index
14
13
```
15
14
Load Diff This file was deleted.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments