diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:48:47 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:48:47 +0200 |
| commit | 4920e4e5dc7457260a2cf6a6725c80076f919a88 (patch) | |
| tree | 9452d2e412d8f33ea029184c96c3d11903b73fba /doc/tutorial | |
| parent | ae3eab278cc39e6d54d3b8f08802e3d7bb4592b7 (diff) | |
| download | sphinx-git-4920e4e5dc7457260a2cf6a6725c80076f919a88.tar.gz | |
Explain that there are several domains
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index d57b48261..bfeca0455 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -5,6 +5,13 @@ In the :doc:`previous sections of the tutorial </tutorial/index>` you can read how to write narrative or prose documentation in Sphinx. In this section you 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 +tutorial you will use the Python domain, but all the concepts seen in this +section apply for the other domains as well. + .. _tutorial-describing-objects: Documenting Python objects |