diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 19:47:11 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 19:47:11 +0900 |
| commit | 2db180da70cfd59ae53afab99d1eb7868fb7d206 (patch) | |
| tree | 4792f14a6e05cd42a1750988949db6cbef17bdbe /doc/tutorial | |
| parent | a457819971f9b32fd57726b1e75f4caa6eaf17ab (diff) | |
| parent | f559389d14d32b1cc70792a5bbbbdfb963e0ce6a (diff) | |
| download | sphinx-git-2db180da70cfd59ae53afab99d1eb7868fb7d206.tar.gz | |
Merge branch '4.x'
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/automatic-doc-generation.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/tutorial/automatic-doc-generation.rst b/doc/tutorial/automatic-doc-generation.rst index df42c6434..b47673d18 100644 --- a/doc/tutorial/automatic-doc-generation.rst +++ b/doc/tutorial/automatic-doc-generation.rst @@ -4,10 +4,9 @@ Automatic documentation generation from code In the :ref:`previous section <tutorial-describing-objects>` of the tutorial you manually documented a Python function in Sphinx. However, the description was out of sync with the code itself, since the function signature was not -the same. Besides, it would be nice to reuse `Python -docstrings <https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring>`_ -in the documentation, rather than having to write the information in two -places. +the same. Besides, it would be nice to reuse :pep:`Python docstrings +<257#what-is-a-docstring>` in the documentation, rather than having to write +the information in two places. Fortunately, :doc:`the autodoc extension </usage/extensions/autodoc>` provides this functionality. |