Improve clarity for `master_doc and root_doc`

This commit is contained in:
Adam Turner committed 2024-10-12 00:16:18 +01:00
1 parent 36ec1407cc
commit c46abc4721
2 files changed
+6 -15

No files matched your search

+5 -12
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
+1 -3
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