Skip to content

Commit c46abc4

Browse files
committed
Improve clarity for master_doc and root_doc
1 parent 36ec140 commit c46abc4

File tree

2 files changed

+6
-15
lines changed

2 files changed

+6
-15
lines changed

doc/development/html_themes/templating.rst

+5-12
Original file line numberDiff line numberDiff line change
@@ -308,20 +308,13 @@ in the future.
308308
.. versionadded:: 4.0
309309

310310
.. data:: master_doc
311+
root_doc
311312

312-
Same as :data:`root_doc`.
313+
The value of :confval:`master_doc` or :confval:`root_doc` (aliases),
314+
for usage with :func:`pathto`.
313315

314-
.. versionchanged:: 4.0
315-
316-
Renamed to ``root_doc``.
317-
318-
.. data:: root_doc
319-
320-
The value of :confval:`root_doc`, for usage with :func:`pathto`.
321-
322-
.. versionchanged:: 4.0
323-
324-
Renamed from ``master_doc``.
316+
.. versionadded:: 4.0
317+
The :data:`!root_doc` template variable.
325318

326319
.. data:: pagename
327320

doc/glossary.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,8 @@ Glossary
7575
For more information, refer to :doc:`/usage/extensions/index`.
7676

7777
master document
78-
The document that contains the root :rst:dir:`toctree` directive.
79-
8078
root document
81-
Same as :term:`master document`.
79+
The document that contains the root :rst:dir:`toctree` directive.
8280

8381
object
8482
The basic building block of Sphinx documentation. Every "object

0 commit comments

Comments
 (0)