IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Insist that automatic is better

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-09-13 15:00:12 +02:00
parent 91a605c6f1
commit d7e525b9db
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/tutorial/automatic-doc-generation.rst
View File

@ -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.