summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-05-29 13:22:21 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-05-29 13:22:21 +0200
commitbfd3b51435c2903e1224d7ee15183e93630fb65a (patch)
treed8c7e635ea8931b7b38decbab124299a6e1af6b0 /doc/tutorial
parent1631291b0e63d02c9eb35ed6681093540b8cf66f (diff)
downloadsphinx-git-bfd3b51435c2903e1224d7ee15183e93630fb65a.tar.gz
Style
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/index.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
index 147c28c3d..60ddfd7b9 100644
--- a/doc/tutorial/index.rst
+++ b/doc/tutorial/index.rst
@@ -117,15 +117,26 @@ you will see the new ``docs`` directory with some content::
These files are:
-- ``build/``: An empty directory (for now)
+``build/``
+
+ An empty directory (for now)
that will hold the rendered documentation.
-- ``make.bat`` and ``Makefile``: Convenience scripts
+
+``make.bat`` and ``Makefile``
+
+ Convenience scripts
to simplify some common Sphinx operations,
such as rendering the content.
-- ``source/conf.py``: A Python script holding the configuration of the Sphinx project.
+
+``source/conf.py``
+
+ A Python script holding the configuration of the Sphinx project.
It contains the project name and release you specified to ``sphinx-quickstart``,
as well as some extra configuration keys.
-- ``source/index.rst``: The :term:`master document` of the project,
+
+``source/index.rst``
+
+ The :term:`master document` of the project,
which serves as welcome page
and contains the root of the "table of contents tree" (or *toctree*).