From 5b3e5d887b680e326fc2eecda60af959cba7c3d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Sat, 29 May 2021 13:44:26 +0200 Subject: [PATCH] Amend code documentation introduction --- doc/tutorial/index.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index 52087db5e..2db15abd4 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -15,10 +15,16 @@ You will create a fictional software library to generate random food recipes that will serve as a guide throughout the process, with the objective of properly documenting it. -To showcase Sphinx automatic documentation generation capabilities -you will use Python, which is the default :term:`domain` -(even though several other languages are supported, -they all work in a similar way). +To showcase Sphinx capabilities for code documentation +you will use Python, +which also supports *automatic* documentation generation. + +.. note:: + + Several other languages are natively supported in Sphinx + for *manual* code documentation, + however they require extensions for *automatic* code documentation, + like `Breathe `_. To follow the instructions you will need access to a Linux-like command line and a basic understanding of how it works,