Skip to content
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

Compatibility with Sphinx 8.2, minor clean up #196

Merged
merged 6 commits into from
Jan 10, 2025
Merged

Conversation

pllim
Copy link
Member

@pllim pllim commented Jan 10, 2025

Goal: Fix devdeps CI

I followed diff in sphinx-doc/sphinx#13212

@pllim
Copy link
Member Author

pllim commented Jan 10, 2025

wow I made it worse lol

@bsipocz
Copy link
Member

bsipocz commented Jan 10, 2025

Ahh, I started working on this just this morning, but haven't got far so will abandon the effort :)

@pllim
Copy link
Member Author

pllim commented Jan 10, 2025

Ooops sorry for the duplicated work, @bsipocz !

@pllim pllim marked this pull request as ready for review January 10, 2025 19:32
@pllim pllim requested a review from bsipocz January 10, 2025 19:32
@pllim
Copy link
Member Author

pllim commented Jan 10, 2025

Should use the "squash and merge" button, or if you want me to manually do it, pls lemme know. Thanks!

Copy link

codecov bot commented Jan 10, 2025

Codecov Report

Attention: Patch coverage is 75.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.09%. Comparing base (594fc12) to head (a054523).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
sphinx_automodapi/automodsumm.py 75.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #196      +/-   ##
==========================================
- Coverage   90.29%   90.09%   -0.21%     
==========================================
  Files          30       30              
  Lines        1206     1211       +5     
==========================================
+ Hits         1089     1091       +2     
- Misses        117      120       +3     

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

@bsipocz
Copy link
Member

bsipocz commented Jan 10, 2025

No worries about duplicates, I only started digging. Actually, I appreciate you opening a draft early on, so we in fact avoided doing much duplicates.

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.

Looks good, but maybe add a few * in the signature?

return old_generate_dot(self, name, urls=fullname_urls, env=env,
graph_attrs=graph_attrs, node_attrs=node_attrs, edge_attrs=edge_attrs)
if SPHINX_LT_8_2:
def patched_generate_dot(self, name, urls={}, env=None,
Copy link
Member

Choose a reason for hiding this comment

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

While we're at this, if possible, make the kwargs mandatory so the API change won't have any chances to bite us back.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added it, though hopefully won't break downstream...

Copy link
Member Author

Choose a reason for hiding this comment

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

@pllim
Copy link
Member Author

pllim commented Jan 10, 2025

Hmm looks like that breaks Sphinx itself... should I revert adding *?

sphinx/ext/inheritance_diagram.py", line 424, in html_visit_inheritance_diagram
    dotcode = graph.generate_dot(name, urls, env=self.builder.env)

@bsipocz
Copy link
Member

bsipocz commented Jan 10, 2025

Ahh, it was worth a try. Go ahead and merge it once CI passes.

@pllim pllim merged commit 77a0e29 into astropy:main Jan 10, 2025
17 of 19 checks passed
@pllim
Copy link
Member Author

pllim commented Jan 10, 2025

Thanks for the review!

@pllim pllim deleted the fix-dev-ci branch January 10, 2025 20:41
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.

2 participants