Skip to content

Conversation

@pllim
Copy link
Member

@pllim pllim commented Nov 4, 2025

for autodoc attribute
@pllim pllim added this to the v0.21.0 milestone Nov 4, 2025
@codecov
Copy link

codecov bot commented Nov 4, 2025

Codecov Report

❌ Patch coverage is 30.00000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.22%. Comparing base (1b47aca) to head (3ebf769).
⚠️ Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
sphinx_automodapi/autodoc_enhancements.py 30.00% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #223      +/-   ##
==========================================
- Coverage   89.69%   89.22%   -0.48%     
==========================================
  Files          31       31              
  Lines        1262     1271       +9     
==========================================
+ Hits         1132     1134       +2     
- Misses        130      137       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pllim
Copy link
Member Author

pllim commented Nov 4, 2025

Hmm doing it in what I thought was the correct way, I get this:

      File "sphinx/events.py", line 402, in emit
        raise ExtensionError(
        ...<4 lines>...
        ) from exc
    sphinx.errors.ExtensionError: Handler <function process_automodsumm_generation at 0x7f0044925440>
        for event 'builder-inited' threw an exception (exception: 'class')

Now I should try the hacky way.

@pllim
Copy link
Member Author

pllim commented Nov 4, 2025

Nope... Also I cannot easily hack-fix this because the inner API has changed upstream:

def _process_documenter_options(
    *,
-    option_spec: OptionSpec,
+    obj_type: _AutodocObjType,

I am starting to be worried that sphinx-automodapi will have to max pin sphinx to work at this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

COMP: sphinx-dev failure with "cannot import name 'AttributeDocumenter' from 'sphinx.ext.autodoc"

1 participant