diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:00:12 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:00:12 +0200 |
| commit | d7e525b9db2c38aad64ffdc244f3f4a5ba4ded1c (patch) | |
| tree | 8581c7c5238d9526d469368b0616335b78962be0 /doc/tutorial | |
| parent | 91a605c6f1a55887f38faf736c76c20ab5562bb3 (diff) | |
| download | sphinx-git-d7e525b9db2c38aad64ffdc244f3f4a5ba4ded1c.tar.gz | |
Insist that automatic is better
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/automatic-doc-generation.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/tutorial/automatic-doc-generation.rst b/doc/tutorial/automatic-doc-generation.rst index 8c6e80236..da263f8ef 100644 --- a/doc/tutorial/automatic-doc-generation.rst +++ b/doc/tutorial/automatic-doc-generation.rst @@ -60,6 +60,7 @@ with :rst:dir:`autofunction`: .. autofunction:: lumache.get_random_ingredients If you now build the HTML documentation, the output will be the same! +With the advantage that it is generated from the code itself. Sphinx took the reStructuredText from the docstring and included it, also generating proper cross-references. |