diff options
| author | Juan Luis Cano RodrÃguez <juanlu@readthedocs.org> | 2021-11-19 01:04:30 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-19 01:04:30 +0300 |
| commit | 79f6d404135389b0e7a74675daf480dc890ae6a2 (patch) | |
| tree | 5f077cf037f8356db7be3283d4ed6574ee7943c5 /doc | |
| parent | eceb6b8f4b26e20246662ce916dc4143376b664d (diff) | |
Apply suggestions from code review
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index bf8ab1c1f..0b88f5bd9 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -240,11 +240,13 @@ Documenting and cross-referencing objects ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Sphinx also supports documenting and cross-referencing objects written in -other programming languages. There are four extra built-in domains: -C, C++, JavaScript, and reStructuredText, and third party extensions may +other programming languages. There are four additional built-in domains: +C, C++, JavaScript, and reStructuredText. Third-party extensions may define domains for more languages, such as -`Fortran <https://sphinx-fortran.readthedocs.io>`_ -or `Julia <http://bastikr.github.io/sphinx-julia>`_. + +- `Fortran <https://sphinx-fortran.readthedocs.io>`_, +- `Julia <http://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 :rst:dir:`cpp:type` directive, as follows: |