IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-03 09:53:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve text of some links

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-13 15:13:01 +02:00
parent 9aa9d0e2ad
commit c2847c2563
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/tutorial/automatic-doc-generation.rst
+1 -1
View File
@@ -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
doc/tutorial/describing-code.rst
+1 -2
View File
@@ -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: