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

Unpin sphinx alternative #14140

Merged
merged 12 commits into from
Dec 9, 2022
Merged

Unpin sphinx alternative #14140

merged 12 commits into from
Dec 9, 2022

Conversation

mhvk
Copy link
Contributor

@mhvk mhvk commented Dec 7, 2022

Description

This pull request is an alternative to #14093 to unpin sphinx. It uses many commits from there that make references canonical, but instead of :noindex:, it replaces the astropy.units.function entry with astropy.units.function.core (which is where classes are actually defined) and uses the automodule directive for astropy.coordinates.builtin_frames so that the docstring and transformation graph are shown, but not all the classes.

Note that this includes also the strange annoyance that the numpy link is not working.

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. Codestyle issues can be fixed by the bot.
  • 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.

@mhvk
Copy link
Contributor Author

mhvk commented Dec 7, 2022

@Cadair
Copy link
Member

Cadair commented Dec 8, 2022

I think that the loss of the list of built in frame classes is unfortunate. I don't know what the best way to generate such a list is, but they are very easily lost in the full module API.

@mhvk
Copy link
Contributor Author

mhvk commented Dec 8, 2022

The list is in the figure; ideally, that would be clickable. But I think we could fairly add the list as a table to the docstring. That would have the benefit that one doesn't get the various Base* frames in there as well.

@Cadair
Copy link
Member

Cadair commented Dec 8, 2022

I think having an explicit list (which is clickable) is all I am after. Autogenerating that in the same way as the graph is 👍 from me.

@mhvk
Copy link
Contributor Author

mhvk commented Dec 8, 2022

@Cadair
Copy link
Member

Cadair commented Dec 8, 2022

Looks good! (Arguably better than the old one)! 🚀

@saimn
Copy link
Contributor

saimn commented Dec 9, 2022

Indeed, no need for :noindex: (astropy/sphinx-automodapi#150) finally but the current solution looks great. I like that the builtin_frames module no more appears in the docs.

@mhvk mhvk merged commit d31499b into astropy:main Dec 9, 2022
@pllim
Copy link
Member

pllim commented Dec 9, 2022

Yay, thanks all!

@mhvk
Copy link
Contributor Author

mhvk commented Dec 9, 2022

Indeed, thanks! I opened #14162 to remind us to put the numpy docs link back to stable.

@pllim
Copy link
Member

pllim commented Dec 19, 2022

I am trying to see how far I can push my luck here.

@meeseeksdev backport to v5.2.x

@meeseeksdev backport to v5.0.x

@lumberbot-app

This comment was marked as resolved.

pllim pushed a commit to meeseeksmachine/astropy that referenced this pull request Dec 22, 2022
@pllim
Copy link
Member

pllim commented Dec 22, 2022

I'll see if I can backport #14206 to v5.0.x 🤪

pllim added a commit that referenced this pull request Dec 22, 2022
…140-on-v5.2.x

Backport PR #14140 on branch v5.2.x (Unpin sphinx alternative)
@pllim pllim modified the milestones: v5.3, v5.0.6 Dec 22, 2022
pllim pushed a commit to pllim/astropy that referenced this pull request Dec 22, 2022
Merge pull request astropy#14140 from mhvk/unpin-sphinx-alternative

Unpin sphinx alternative

(cherry picked from commit d31499b)
@pllim pllim mentioned this pull request Apr 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants