Skip to content

Compatibility with Sphinx dev for autodoc attribute #223

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

Closed
wants to merge 2 commits into from
Closed

Compatibility with Sphinx dev for autodoc attribute #223

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
912f982
Compatibility with Sphinx dev
pllim Nov 4, 2025
3ebf769
Try hacky way now
pllim Nov 4, 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
16 changes: 15 additions & 1 deletion sphinx_automodapi/autodoc_enhancements.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""
import dataclasses

from sphinx.ext.autodoc import AttributeDocumenter
from .utils import SPHINX_LT_8_3

__all__ = []

Expand Down Expand Up @@ -80,6 +80,20 @@ def setup(app):
if 'app.add_directive' not in app.config.suppress_warnings:
app.config.suppress_warnings.append('app.add_directive')
try:
if SPHINX_LT_8_3:
from sphinx.ext.autodoc import AttributeDocumenter

else:
from sphinx.ext.autodoc._directive_options import annotation_option, bool_option
from sphinx.ext.autodoc._documenters import Documenter

class AttributeDocumenter(Documenter):
"""Specialized Documenter subclass for attributes."""
objtype = 'attribute'
option_spec = dict(Documenter.option_spec)
option_spec['annotation'] = annotation_option
option_spec['no-value'] = bool_option

app.add_autodocumenter(AttributeDocumenter)
finally:
app.config.suppress_warnings = suppress_warnings_orig
Expand Down
Loading