Skip to content

MNT: Unpin maxversion of Sphinx and Jinja2#13015

Closed
pllim wants to merge 2 commits intoastropy:mainfrom
pllim:unpin-sphinx-try99
Closed

MNT: Unpin maxversion of Sphinx and Jinja2#13015
pllim wants to merge 2 commits intoastropy:mainfrom
pllim:unpin-sphinx-try99

Conversation

@pllim
Copy link
Member

@pllim pllim commented Mar 30, 2022 •
edited
Loading

Description

This pull request is another attempt to fix #11725

Close #12270

If you disagree this needs backporting, please remilestone and remove the backport label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see "When to rebase and squash commits".
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the Extra CI label.
  • Is a change log needed? If yes, did the change log check pass? If no, add the no-changelog-entry-needed label. If this is a manual backport, use the skip-changelog-checks label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but astropy-bot check might be missing; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate backport-X.Y.x label(s) before merge.

@pllim pllim added this to the v5.0.4 milestone Mar 30, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 30, 2022

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

@pllim pllim mentioned this pull request Mar 30, 2022
Closed
@pllim pllim force-pushed the unpin-sphinx-try99 branch from 6ba5a77 to 37908ba Compare March 30, 2022 19:05
pllim
pllim commented Mar 30, 2022
View reviewed changes
@pllim pllim force-pushed the unpin-sphinx-try99 branch from 37908ba to 554c395 Compare March 30, 2022 19:13
@pllim pllim mentioned this pull request Mar 30, 2022
Closed
9 tasks
@pllim
Copy link
Member Author

pllim commented Mar 30, 2022

Whatever magic that worked for photutils is not working here.

pllim added 2 commits March 30, 2022 18:10
@pllim
MNT: Unpin maxversion of Sphinx and Jinja2
64f0a62
@pllim
coordinates __all__ to be compatible
59ce382 
with sphinx>=4

tried to mimic photutils but did not work

[ci skip]
@pllim pllim force-pushed the unpin-sphinx-try99 branch from 5c1ce37 to 59ce382 Compare March 30, 2022 22:12
@larrybradley
Copy link
Member

larrybradley commented Mar 31, 2022

Did you exclude the sub-sub-package from __all__? That's essentially what I did in astropy/photutils#1306 to solve the issue.

@pllim
Copy link
Member Author

pllim commented Mar 31, 2022

Did you exclude the sub-sub-package

What do you mean, @larrybradley ? All I see there is you import from . import subpackage. Did I miss something fundamental there?

@larrybradley
Copy link
Member

larrybradley commented Mar 31, 2022

Yes, you missed something. The from . import subpackage imports are so I can manually define the __all__ list (extending it with the subpackage.__all__ lists). When I manually construct __all__, I do NOT include the sub-subpackage that was causing the warnings. In my case, note that the matching sub-subpackage does not get put into __all__.

@larrybradley
Copy link
Member

larrybradley commented Mar 31, 2022

Do not include in __all__ whichever sub-subpackage is causing the warning.

@pllim
Copy link
Member Author

pllim commented Mar 31, 2022

I am not sure if that is possible for coordinates. Magical things seem to happen in that __init__.py but I guess I can try again when I get a chance...

@larrybradley
Copy link
Member

larrybradley commented Mar 31, 2022

It would be nice to get this fixed (perhaps even upstream in astropy/sphinx-automodapi) because one cannot build the docs locally with Python 3.10 and Sphinx < 4. That's what motivated me to do the photutils workaround.

@pllim
Copy link
Member Author

pllim commented Mar 31, 2022

Upstream fix is beyond me. My sphinx-fu is weak...

@pllim pllim modified the milestones: v5.0.4, v5.0.5 Mar 31, 2022
@pllim
Copy link
Member Author

pllim commented Apr 1, 2022

See #13048

@pllim pllim closed this Apr 1, 2022
@pllim pllim deleted the unpin-sphinx-try99 branch April 1, 2022 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adrn adrn adrn left review comments

Assignees

No one assigned

Labels

installation no-changelog-entry-needed

Projects

None yet

Milestone

v5.0.5

Development

Successfully merging this pull request may close these issues.

DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out (and Jinja2)

3 participants

@pllim @larrybradley @adrn