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

Style

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-05-29 13:22:21 +02:00
parent 1631291b0e
commit bfd3b51435
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/tutorial/index.rst
View File

@ -117,15 +117,26 @@ you will see the new ``docs`` directory with some content::
These files are: These files are:
- ``build/``: An empty directory (for now) ``build/``
An empty directory (for now)
that will hold the rendered documentation. that will hold the rendered documentation.
- ``make.bat`` and ``Makefile``: Convenience scripts
``make.bat`` and ``Makefile``
Convenience scripts
to simplify some common Sphinx operations, to simplify some common Sphinx operations,
such as rendering the content. 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``, It contains the project name and release you specified to ``sphinx-quickstart``,
as well as some extra configuration keys. 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 which serves as welcome page
and contains the root of the "table of contents tree" (or *toctree*). and contains the root of the "table of contents tree" (or *toctree*).