From ae1bcc2cdeae1364da66c2f1aec82e65cf4cf98d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Gonz=C3=A1lez?= Date: Mon, 10 Mar 2025 11:47:41 +0100 Subject: [PATCH] add link to auto_mode in sphinx-autodoc2 fixes #1031 --- docs/syntax/code_and_apis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax/code_and_apis.md b/docs/syntax/code_and_apis.md index 771b843d..aeb3ee21 100644 --- a/docs/syntax/code_and_apis.md +++ b/docs/syntax/code_and_apis.md @@ -170,7 +170,7 @@ Sphinx and MyST provide means to analyse source code and automatically generate 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. -The `auto_mode` will automatically generate the full API documentation, as shown . +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 . Alternatively, the `autodoc2-object` directive can be used to generate documentation for a single object. To embed in a MyST document the MyST `render_plugin` should be specified, for example: