diff options
Diffstat (limited to 'doc/tutorial/describing-code.rst')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index 24fea38..16feb2a 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -8,7 +8,7 @@ will describe code objects instead. Sphinx supports documenting code objects in several languages, namely Python, C, C++, JavaScript, and reStructuredText. Each of them can be documented using a series of directives and roles grouped by -:doc:`domain </usage/restructuredtext/domains>`. For the remainder of the +:doc:`domain </usage/domains/index>`. For the remainder of the tutorial you will use the Python domain, but all the concepts seen in this section apply for the other domains as well. @@ -21,9 +21,9 @@ Documenting Python objects ~~~~~~~~~~~~~~~~~~~~~~~~~~ Sphinx offers several roles and directives to document Python objects, -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: +all grouped together in :doc:`the Python domain </usage/domains/python>`. +For example, you can use the :rst:dir:`py:function` directive to document +a Python function, as follows: .. code-block:: rst :caption: docs/source/usage.rst @@ -228,7 +228,7 @@ for easy examination. It is now time to fix the function: def get_random_ingredients(kind=None): return ["shells", "gorgonzola", "parsley"] -And finally, ``make test`` reports success! +And finally, ``make doctest`` reports success! For big projects though, this manual approach can become a bit tedious. In the next section, you will see :doc:`how to automate the @@ -246,7 +246,7 @@ C, C++, JavaScript, and reStructuredText. Third-party extensions may define domains for more languages, such as - `Fortran <https://sphinx-fortran.readthedocs.io>`_, -- `Julia <http://bastikr.github.io/sphinx-julia>`_, or +- `Julia <https://bastikr.github.io/sphinx-julia>`_, or - `PHP <https://github.com/markstory/sphinxcontrib-phpdomain>`_. For example, to document a C++ type definition, you would use the built-in |