diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:13:01 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:13:01 +0200 |
| commit | c2847c2563ded91c560710fe237ca37518dcd9e9 (patch) | |
| tree | 4db7de3ef10280aca3eda6080dbac092c9378d6a /doc/tutorial | |
| parent | 9aa9d0e2ad5b1d166881caff0f623b4efe6c5f60 (diff) | |
| download | sphinx-git-c2847c2563ded91c560710fe237ca37518dcd9e9.tar.gz | |
Improve text of some links
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/automatic-doc-generation.rst | 2 | ||||
| -rw-r--r-- | doc/tutorial/describing-code.rst | 3 |
2 files changed, 2 insertions, 3 deletions
diff --git a/doc/tutorial/automatic-doc-generation.rst b/doc/tutorial/automatic-doc-generation.rst index 409bc43d6..ead741780 100644 --- a/doc/tutorial/automatic-doc-generation.rst +++ b/doc/tutorial/automatic-doc-generation.rst @@ -9,7 +9,7 @@ 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. -Fortunately, :doc:`autodoc </usage/extensions/autodoc>` provides this +Fortunately, :doc:`the autodoc extension </usage/extensions/autodoc>` provides this functionality. Reusing signatures and docstrings with autodoc diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index f5c5391ff..f353f9af1 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -11,8 +11,7 @@ Documenting Python objects -------------------------- Sphinx offers several roles and directives to document Python objects, -all grouped together in the Python -:doc:`domain </usage/restructuredtext/domains>`. For example, you can +all grouped together in :ref:`the Python domain <python-domain>`. For example, you can use the :rst:dir:`py:function` directive to document a Python function, as follows: |