-
-
Notifications
You must be signed in to change notification settings - Fork 49
Fix incomplete cleanup in autodoc_enhancements.py #224
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.
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
Conversation
|
Please can someone approve the workflows? |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #224 +/- ##
==========================================
- Coverage 89.69% 89.62% -0.08%
==========================================
Files 31 31
Lines 1262 1253 -9
==========================================
- Hits 1132 1123 -9
Misses 130 130 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I think this is hitting one of the errors I saw in #223 that I do not understand. |
|
@pllim slightly hubristicly, I put up this PR without running tests, as I didn't want to set up a full environment for the project! Using Sphinx's File "...\sphinx-automodapi\sphinx_automodapi\utils.py", line 256, in get_documenter
retval = app.registry.documenters[obj_type]
~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
KeyError: 'class'I've thus applied the suggestion I made elsewhere to change the vendored A |
pllim
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, thank you very much! This is much cleaner than what I came up with, and appears to make all Sphinx versions under test happy. Appreciate the help.
|
Thank you so much @AA-Turner!
|
|
I'm not sure it would help, it's for interactive debugging only: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-P |
Ahh, never mind it then. |
cc @pllim @bsipocz
This removes vestigal code left over from previous incomplete cleanups.
Previously,
sphinx-automodapiredefinedAttributeDocumenterand overwrote Sphinx's version with its own. See sphinx-doc/sphinx#1843, astropy/astropy-helpers#158.This was removed in 412a801 (#88), but overriding Sphinx's
AttributeDocumenterwas retained for unclear reasons. This PR completes the cleanup.Alternative to and would close #223. Also fix #222
A