Skip to content

Remove section_parents #13560

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 1 commit into
base: master
Choose a base branch
from
Open

Remove section_parents #13560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 1 addition & 13 deletions sphinx/directives/other.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
from pathlib import Path
from typing import TYPE_CHECKING, cast

import docutils
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.parsers.rst.directives.misc import Class
Expand All @@ -22,15 +21,14 @@

if TYPE_CHECKING:
from collections.abc import Sequence
from typing import Any, ClassVar, Final
from typing import Any, ClassVar

from docutils.nodes import Element, Node

from sphinx.application import Sphinx
from sphinx.util.typing import ExtensionMetadata, OptionSpec


DU_22_PLUS: Final = docutils.__version_info__ >= (0, 22, 0, 'alpha', 0)
glob_re = re.compile(r'.*[*?\[].*')
logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -332,14 +330,6 @@ def run(self) -> list[Node]:
surrounding_section_level = memo.section_level
memo.title_styles = []
memo.section_level = 0
if DU_22_PLUS:
# https://github.com/sphinx-doc/sphinx/issues/13539
# https://sourceforge.net/p/docutils/code/10093/
# https://sourceforge.net/p/docutils/patches/213/
surrounding_section_parents = memo.section_parents
memo.section_parents = []
else:
surrounding_section_parents = []
try:
self.state.nested_parse(
self.content, self.content_offset, node, match_titles=True
Expand Down Expand Up @@ -375,8 +365,6 @@ def run(self) -> list[Node]:
return []
finally:
memo.title_styles = surrounding_title_styles
if DU_22_PLUS:
memo.section_parents = surrounding_section_parents
memo.section_level = surrounding_section_level


Expand Down
12 changes: 0 additions & 12 deletions sphinx/util/parsing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,15 @@
import contextlib
from typing import TYPE_CHECKING

import docutils
from docutils.nodes import Element
from docutils.statemachine import StringList, string2lines

if TYPE_CHECKING:
from collections.abc import Iterator
from typing import Final

from docutils.nodes import Node
from docutils.parsers.rst.states import RSTState

DU_22_PLUS: Final = docutils.__version_info__ >= (0, 22, 0, 'alpha', 0)


def nested_parse_to_nodes(
state: RSTState,
Expand Down Expand Up @@ -79,23 +75,15 @@ def _fresh_title_style_context(state: RSTState) -> Iterator[None]:
memo = state.memo
surrounding_title_styles: list[str | tuple[str, str]] = memo.title_styles
surrounding_section_level: int = memo.section_level
if DU_22_PLUS:
surrounding_section_parents = memo.section_parents
else:
surrounding_section_parents = []
# clear current title styles
memo.title_styles = []
memo.section_level = 0
if DU_22_PLUS:
memo.section_parents = []
try:
yield
finally:
# reset title styles
memo.title_styles = surrounding_title_styles
memo.section_level = surrounding_section_level
if DU_22_PLUS:
memo.section_parents = surrounding_section_parents


def _text_to_string_list(
Expand Down
7 changes: 0 additions & 7 deletions 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 @@ -2,7 +2,6 @@

from types import SimpleNamespace

import docutils
from docutils import nodes
from docutils.parsers.rst.languages import en as english # type: ignore[attr-defined]
from docutils.parsers.rst.states import (
Expand Down Expand Up @@ -45,16 +44,10 @@ def make_directive_and_state(
reporter=document.reporter,
language=english,
title_styles=[],
# section_parents=[], # Docutils 0.22+
section_level=0,
section_bubble_up_kludge=False,
inliner=inliner,
)
if docutils.__version_info__ >= (0, 22, 0, 'alpha', 0):
# https://github.com/sphinx-doc/sphinx/issues/13539
# https://sourceforge.net/p/docutils/code/10093/
# https://sourceforge.net/p/docutils/patches/213/
state.memo.section_parents = []
directive = SphinxDirective(
name='test_directive',
arguments=[],
Expand Down
Loading