-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Unpin sphinx alternative #14140
Conversation
New "Built-in Frame Classes" part of documentation at https://astropy--14140.org.readthedocs.build/en/14140/coordinates/index.html#module-astropy.coordinates.builtin_frames |
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. |
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 |
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. |
1) typeset astropy.units.function.core instead of function 2) Use automodule for astropy.coordinates.builtin_frames
as suggested by larrybradley
75108d4
to
5d8e440
Compare
Looks good! (Arguably better than the old one)! 🚀 |
Indeed, no need for |
6575af7
to
5ce31bf
Compare
Yay, thanks all! |
Indeed, thanks! I opened #14162 to remind us to put the numpy docs link back to stable. |
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 |
This comment was marked as resolved.
This comment was marked as resolved.
I'll see if I can backport #14206 to v5.0.x 🤪 |
…140-on-v5.2.x Backport PR #14140 on branch v5.2.x (Unpin sphinx alternative)
Merge pull request astropy#14140 from mhvk/unpin-sphinx-alternative Unpin sphinx alternative (cherry picked from commit d31499b)
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 theastropy.units.function
entry withastropy.units.function.core
(which is where classes are actually defined) and uses theautomodule
directive forastropy.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.
Extra CI
label. Codestyle issues can be fixed by the bot.no-changelog-entry-needed
label. If this is a manual backport, use theskip-changelog-checks
label unless special changelog handling is necessary.astropy-bot
check might be missing; do not let the green checkmark fool you.backport-X.Y.x
label(s) before merge.