Skip to content

Commit ae1bcc2

Browse files
authored
add link to auto_mode in sphinx-autodoc2
fixes executablebooks#1031
1 parent 8a44f5d commit ae1bcc2

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/syntax/code_and_apis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Sphinx and MyST provide means to analyse source code and automatically generate
170170

171171
As opposed to `sphinx.ext.autodoc`, `sphinx-autodoc2` performs static (rather than dynamic) analysis of the source code, integrates full package documenting, and also allows for docstrings to be written in both RestructureText and MyST.
172172

173-
The `auto_mode` will automatically generate the full API documentation, as shown <project:/apidocs/index.rst>.
173+
The [sphinx-autodoc2's `auto_mode` config variable](https://sphinx-autodoc2.readthedocs.io/en/latest/config.html#confval-autodoc2_packages-auto_mode) (which per default is `True`) will automatically generate the full API documentation, as shown <project:/apidocs/index.rst>.
174174

175175
Alternatively, the `autodoc2-object` directive can be used to generate documentation for a single object.
176176
To embed in a MyST document the MyST `render_plugin` should be specified, for example:

0 commit comments

Comments
 (0)