diff options
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/index.rst | 19 |
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*). |