Skip to content

Conversation

@pllim
Copy link
Member

@pllim pllim commented Oct 28, 2025

Move get_documenter over from Sphinx because it was removed upstream in sphinx-doc/sphinx#13985 . This is as suggested by Sphinx developer in #219 (comment)

Fix #219

Towards astropy/sphinx-astropy#86

@pllim pllim added this to the v0.21.0 milestone Oct 28, 2025
@pllim

This comment was marked as resolved.

@pllim pllim force-pushed the fix-sphinxdev-get-docu branch from f5c05c8 to 1b47aca Compare October 28, 2025 19:27
@codecov
Copy link

codecov bot commented Oct 28, 2025

Codecov Report

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

Files with missing lines Patch % Lines
sphinx_automodapi/utils.py 72.72% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #220      +/-   ##
==========================================
- Coverage   89.83%   89.69%   -0.14%     
==========================================
  Files          31       31              
  Lines        1249     1262      +13     
==========================================
+ Hits         1122     1132      +10     
- Misses        127      130       +3     

☔ 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 pllim marked this pull request as ready for review October 28, 2025 19:33
@AA-Turner
Copy link
Contributor

IIUC you only use the returned Documenter class for the objtype attribute, so I think you could simplify things here by returning retval.objtype if Sphinx 8.2 or older, and obj_type otherwise.

A

@pllim
Copy link
Member Author

pllim commented Oct 28, 2025

Thanks, but I'd rather just do what it used to do to avoid any unintentional side effect.

@bsipocz
Copy link
Member

bsipocz commented Nov 3, 2025

I would say it may be worth exploring to do the simplification suggested above, but OTOH I think we should focus on the bigger picture and spend the time exploring #147.

So let's have this in as is, and put some focus on #147

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thanks @pllim!

@bsipocz bsipocz merged commit 0aa9864 into astropy:main Nov 3, 2025
18 of 20 checks passed
@pllim pllim deleted the fix-sphinxdev-get-docu branch November 3, 2025 19:13
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 due to automodsummary.get_documenter removal

3 participants