Skip to content

Use normalize_options() from Docutils in preference to set_classes() #13844

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

Merged
merged 6 commits into from
Oct 5, 2025
Merged

Use normalize_options() from Docutils in preference to set_classes() #13844

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0601f7b
MAINT: changing deprecated set_classes to normalize_options
bsipocz Aug 18, 2025
50b31ec
Adding version checking for deprecated usage
bsipocz Aug 18, 2025
a5591a6
Merge branch 'master' into MAINT_update_deprecated_docutils_usage
bsipocz Sep 2, 2025
92e0169
Merge branch 'master' into MAINT_update_deprecated_docutils_usage
AA-Turner Oct 5, 2025
69619b4
normalize_options returns a fresh dict
AA-Turner Oct 5, 2025
d1b6ff7
mypy
AA-Turner Oct 5, 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: 3 additions & 3 deletions sphinx/directives/patches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from docutils.parsers.rst import directives
from docutils.parsers.rst.directives import images, tables
from docutils.parsers.rst.directives.misc import Meta
from docutils.parsers.rst.roles import set_classes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still need the old name for old versions of Docutils, which we still support

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I suspected that this needs to be version dependent. I'll add a checker, though first will need to sort out what goes wrong for the latest docutils where it should work

from docutils.parsers.rst.roles import normalize_options

from sphinx.directives import optional_int
from sphinx.locale import __
Expand Down Expand Up @@ -100,7 +100,7 @@ class Code(SphinxDirective):
def run(self) -> list[Node]:
self.assert_has_content()

set_classes(self.options)
normalize_options(self.options)
code = '\n'.join(self.content)
node = nodes.literal_block(
code,
Expand Down Expand Up @@ -215,7 +215,7 @@ class Rubric(SphinxDirective):
}

def run(self) -> list[nodes.rubric | nodes.system_message]:
set_classes(self.options)
normalize_options(self.options)
rubric_text = self.arguments[0]
textnodes, messages = self.parse_inline(rubric_text, lineno=self.lineno)
if 'heading-level' in self.options:
Expand Down
3 changes: 2 additions & 1 deletion sphinx/roles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,10 +584,11 @@ def code_role(
options: dict[str, Any] | None = None,
content: Sequence[str] = (),
) -> tuple[list[Node], list[system_message]]:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh, and this annoys Ruff, though I explicitly added the line as it was very difficult to see where the signature ends and the actual code starts.

if options is None:
options = {}
options = options.copy()
docutils.parsers.rst.roles.set_classes(options)
docutils.parsers.rst.roles.normalize_options(options)
language = options.get('language', '')
classes = ['code']
if language:
Expand Down
Loading