Improve clarity for master_doc and root_doc

sphinx-doc · Oct 11, 2024 · c46abc4 · c46abc4
1 parent 36ec140
commit c46abc4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 15 deletions.
diff --git a/doc/development/html_themes/templating.rst b/doc/development/html_themes/templating.rst
@@ -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
 

diff --git a/doc/glossary.rst b/doc/glossary.rst
@@ -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