diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 01:46:22 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 01:46:22 +0900 |
| commit | fbdfade0687e67af2d822c830cf5ace8a53ed7aa (patch) | |
| tree | 6cc7c2b96453d90893c240ef213a7f04c4769767 /doc/tutorial | |
| parent | 3816bcdfa9cf65f9af6c70bbf7837fd51841ddfa (diff) | |
| download | sphinx-git-fbdfade0687e67af2d822c830cf5ace8a53ed7aa.tar.gz | |
doc: Use :pep: role to refer PEP documents
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 6a56dbd3a..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://peps.python.org/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. |