Skip to content

Fix docstring of sphinx.util.parsing.nested_parse_to_nodes(). #13884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+5 −3
Open

Fix docstring of sphinx.util.parsing.nested_parse_to_nodes(). #13884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fa3b85
Fix test setup for directive tests.
gmilde Sep 9, 2025
5f00fab
Fix docstring of sphinx.util.parsing.nested_parse_to_nodes().
gmilde Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions sphinx/util/parsing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ def nested_parse_to_nodes(
Note that this option bypasses Docutils' usual checks on
doctree structure, and misuse of this option can lead to
an incoherent doctree. In Docutils, section nodes should
only be children of ``Structural`` nodes, which includes
``document``, ``section``, and ``sidebar`` nodes.
only be children of ``document`` or ``section`` nodes.
:param keep_title_context:
If this is False (the default), then *content* is parsed as if it were
an independent document, meaning that title decorations (e.g. underlines)
Expand All @@ -49,6 +48,9 @@ def nested_parse_to_nodes(
a completely different context, such as docstrings.
If this is True, then title underlines must match those in
the surrounding document, otherwise the behaviour is undefined.
Warning: Up to Docutils 0.21, sections with an decoration style
matching a level that is higher than the current section level are
silently discarded! Since Docutils 0.22.1, an error is reported.

.. versionadded:: 7.4
"""
Expand Down
2 changes: 1 addition & 1 deletion tests/test_util/test_util_docutils_sphinx_directive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def make_directive_and_state(
inliner = Inliner()
inliner.init_customizations(document.settings)
state.inliner = inliner
state.parent = None
state.parent = document
state.memo = SimpleNamespace(
document=document,
reporter=document.reporter,
Expand Down
Loading