From 4920e4e5dc7457260a2cf6a6725c80076f919a88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Mon, 13 Sep 2021 15:48:47 +0200 Subject: Explain that there are several domains --- doc/tutorial/describing-code.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/tutorial') 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 ` 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 `. 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 -- cgit v1.2.1