From fbdfade0687e67af2d822c830cf5ace8a53ed7aa Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 27 Mar 2022 01:46:22 +0900 Subject: doc: Use :pep: role to refer PEP documents --- doc/tutorial/automatic-doc-generation.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'doc/tutorial') 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 ` 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 `_ -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 ` provides this functionality. -- cgit v1.2.1