summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-06-22 15:26:59 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-06-22 15:27:54 +0200
commitc9d2a73d93cd933616a93684a7b7ab7ce141e7f6 (patch)
tree483c2e30072fd2af0b619074fd9cdaf0618f2e31
parent5f41044abb6802291989de8b34cd587b7e79ec1c (diff)
downloadsphinx-git-c9d2a73d93cd933616a93684a7b7ab7ce141e7f6.tar.gz
Rename to root document
-rw-r--r--doc/glossary.rst2
-rw-r--r--doc/templating.rst2
-rw-r--r--doc/tutorial/index.rst4
-rw-r--r--doc/usage/advanced/setuptools.rst2
-rw-r--r--doc/usage/builders/index.rst2
-rw-r--r--doc/usage/quickstart.rst4
6 files changed, 8 insertions, 8 deletions
diff --git a/doc/glossary.rst b/doc/glossary.rst
index 87b7014b6..f989df1ae 100644
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -73,7 +73,7 @@ Glossary
For more information, refer to :doc:`/usage/extensions/index`.
- master document
+ root document
The document that contains the root :rst:dir:`toctree` directive.
object
diff --git a/doc/templating.rst b/doc/templating.rst
index 0e9d38add..b25372319 100644
--- a/doc/templating.rst
+++ b/doc/templating.rst
@@ -115,7 +115,7 @@ The following blocks exist in the ``layout.html`` template:
``rootrellink``, ``relbaritems``
Inside the relbar there are three sections: The ``rootrellink``, the links
from the documentation and the custom ``relbaritems``. The ``rootrellink``
- is a block that by default contains a list item pointing to the master
+ is a block that by default contains a list item pointing to the root
document by default, the ``relbaritems`` is an empty block. If you
override them to add extra links into the bar make sure that they are list
items and end with the :data:`reldelim1`.
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
index 1e600e637..8ab1fc287 100644
--- a/doc/tutorial/index.rst
+++ b/doc/tutorial/index.rst
@@ -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
diff --git a/doc/usage/advanced/setuptools.rst b/doc/usage/advanced/setuptools.rst
index f4dfb7f66..7f993e10c 100644
--- a/doc/usage/advanced/setuptools.rst
+++ b/doc/usage/advanced/setuptools.rst
@@ -164,7 +164,7 @@ Options for setuptools integration
.. setuptools-confval:: link-index
- A boolean that ensures index.html will be linked to the master doc. Default
+ A boolean that ensures index.html will be linked to the root doc. Default
is false.
This can also be set by passing the `-i` flag to ``setup.py``:
diff --git a/doc/usage/builders/index.rst b/doc/usage/builders/index.rst
index 74853fee9..4d5315227 100644
--- a/doc/usage/builders/index.rst
+++ b/doc/usage/builders/index.rst
@@ -51,7 +51,7 @@ The builder's "name" must be given to the **-b** command-line option of
This is an HTML builder that combines the whole project in one output file.
(Obviously this only works with smaller projects.) The file is named like
- the master document. No indices will be generated.
+ the root document. No indices will be generated.
.. autoattribute:: name
diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst
index 83b5211bd..ec36f5df9 100644
--- a/doc/usage/quickstart.rst
+++ b/doc/usage/quickstart.rst
@@ -48,8 +48,8 @@ Defining document structure
---------------------------
Let's assume you've run :program:`sphinx-quickstart`. It created a source
-directory with :file:`conf.py` and a master document, :file:`index.rst`. The
-main function of the :term:`master document` is to serve as a welcome page, and
+directory with :file:`conf.py` and a root document, :file:`index.rst`. The
+main function of the :term:`root document` is to serve as a welcome page, and
to contain the root of the "table of contents tree" (or *toctree*). This is one
of the main things that Sphinx adds to reStructuredText, a way to connect
multiple files to a single hierarchy of documents.