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

Avoid reference to earlier content

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-06-21 07:30:02 +02:00
parent e75f31ad47
commit d08c3677d1
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/tutorial/index.rst
View File

@ -318,10 +318,11 @@ Narrative documentation in Sphinx
Inserting documents in the project hierarchy Inserting documents in the project hierarchy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As discussed at the beginning, ``index.rst`` is the :term:`master document`, The file ``index.rst`` created by ``sphinx-quickstart`` is the :term:`master
whose main function is to serve as a welcome page and to contain the root of document`, whose main function is to serve as a welcome page and to contain the
the "table of contents tree" (or *toctree*). Sphinx allows you to assemble root of the "table of contents tree" (or *toctree*). Sphinx allows you to
a project from different files, which is helpful when the project grows. assemble a project from different files, which is helpful when the project
grows.
As an example, create a new file ``docs/source/usage.rst`` (next to As an example, create a new file ``docs/source/usage.rst`` (next to
``index.rst``) with these contents: ``index.rst``) with these contents: