Skip to content

Extract _generate_directives() from Documenter._generate() #13985

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 1 commit into from
Oct 21, 2025
Merged

Extract _generate_directives() from Documenter._generate() #13985

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
2 changes: 1 addition & 1 deletion doc/development/tutorials/examples/autodoc_intenum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from typing import TYPE_CHECKING

from sphinx.ext.autodoc import ClassDocumenter, bool_option
from sphinx.ext.autodoc._documenters import _docstring_source_name
from sphinx.ext.autodoc._generate import _docstring_source_name

if TYPE_CHECKING:
from typing import Any
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ exclude = [
[tool.mypy]
files = [
"doc/conf.py",
"doc/development/tutorials/examples/autodoc_intenum.py",
# "doc/development/tutorials/examples/autodoc_intenum.py",
"doc/development/tutorials/examples/helloworld.py",
"sphinx",
"tests",
Expand Down
3 changes: 1 addition & 2 deletions sphinx/ext/autodoc/_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ def _process_docstrings(
*,
events: EventManager,
props: _ItemProperties,
obj: Any,
options: _AutoDocumenterOptions,
) -> Iterator[str]:
"""Let the user process the docstrings before adding them."""
Expand All @@ -89,7 +88,7 @@ def _process_docstrings(
'autodoc-process-docstring',
props.obj_type,
props.full_name,
obj,
props._obj,
options,
docstring_lines,
)
Expand Down
Loading
Loading