IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-08 20:18:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Rename to root document

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-06-22 15:27:54 +02:00
parent 5f41044abb
commit c9d2a73d93
6 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/tutorial/index.rst
+2 -2
View File
@@ -128,7 +128,7 @@ The purpose of each of these files is:
as some extra configuration keys.
``source/index.rst``
The :term:`master document` of the project, which serves as welcome page and
The :term:`root document` of the project, which serves as welcome page and
contains the root of the "table of contents tree" (or *toctree*).
Thanks to this bootstrapping step, you already have everything needed to render
@@ -322,7 +322,7 @@ Narrative documentation in Sphinx
Structuring your documentation across multiple pages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The file ``index.rst`` created by ``sphinx-quickstart`` is the :term:`master
The file ``index.rst`` created by ``sphinx-quickstart`` is the :term:`root
document`, whose main function is to serve as a welcome page and to contain the
root of the "table of contents tree" (or *toctree*). Sphinx allows you to
assemble a project from different files, which is helpful when the project