IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Amend code documentation introduction

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-05-29 13:44:26 +02:00
parent d6cb2d0c38
commit 5b3e5d887b
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/tutorial/index.rst
View File

@ -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 <https://breathe.readthedocs.io/>`_.
To follow the instructions you will need access to a Linux-like command line
and a basic understanding of how it works,