Skip to content

Commit 4920e4e

Browse files
committed
Explain that there are several domains
1 parent ae3eab2 commit 4920e4e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/tutorial/describing-code.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ In the :doc:`previous sections of the tutorial </tutorial/index>` you can read
55
how to write narrative or prose documentation in Sphinx. In this section you
66
will describe code objects instead.
77

8+
Sphinx supports documenting code objects in several languages, namely Python,
9+
C, C++, JavaScript, and reStructuredText. Each of them can be documented using
10+
a series of directives and roles grouped by
11+
:doc:`domain </usage/restructuredtext/domains>`. For the remainder of the
12+
tutorial you will use the Python domain, but all the concepts seen in this
13+
section apply for the other domains as well.
14+
815
.. _tutorial-describing-objects:
916

1017
Documenting Python objects

0 commit comments

Comments
 (0)