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

Improve clarity for `master_doc and root_doc`

Browse Source
This commit is contained in:
Adam Turner
2024-10-12 00:16:01 +01:00
parent 36ec1407cc
commit c46abc4721
2 changed files with 6 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/development/html_themes/templating.rst
View File

@@ -308,20 +308,13 @@ in the future.
.. versionadded:: 4.0
.. data:: master_doc
root_doc
Same as :data:`root_doc`.
The value of :confval:`master_doc` or :confval:`root_doc` (aliases),
for usage with :func:`pathto`.
.. versionchanged:: 4.0
Renamed to ``root_doc``.
.. data:: root_doc
The value of :confval:`root_doc`, for usage with :func:`pathto`.
.. versionchanged:: 4.0
Renamed from ``master_doc``.
.. versionadded:: 4.0
The :data:`!root_doc` template variable.
.. data:: pagename

4
doc/glossary.rst
View File

@@ -75,10 +75,8 @@ Glossary
For more information, refer to :doc:`/usage/extensions/index`.
master document
The document that contains the root :rst:dir:`toctree` directive.
root document
Same as :term:`master document`.
The document that contains the root :rst:dir:`toctree` directive.
object
The basic building block of Sphinx documentation. Every "object