Fix Sphinx>4 warnings with units and coordinates#13048
Fix Sphinx>4 warnings with units and coordinates#13048saimn wants to merge 2 commits intoastropy:mainfrom
Conversation
|
You will be upgraded. (A special day message.) |
|
Please don't tell me this is April Fool PR. My heart can't take it. It looks so elegant! |
|
Don't worry about mpl or numpy dev failures. They are not related. |
|
RTD is green! 🎉 |
|
cc @maxnoe |
|
But that just removes the corresponding documentation. This is not what we want, right? We want a way to avoid these warnings without loosing the documentation pages. |
|
Yes, so the idea was first to see if this fixes the warnings. Those functions are already documented at the top level, and are duplicated in a specific section. |
|
IMHO the benefit of getting rid of two maxversion pins outweighs the cost of losing some duplicate doc in coordinates. I have no idea when sphinx-automodapi will get fixed and this has been plaguing us long enough. Can we go ahead with this and then open up follow-up issue (or comment on existing ones)? |
|
|
||
| .. automodapi:: astropy.units.equivalencies | ||
|
|
||
| .. automodapi:: astropy.units.function |
There was a problem hiding this comment.
why are these removed? They are distinct from astropy.units.function.units and, e.g., STmag does not seem to be linked anywhere else on the present doc pages.
There was a problem hiding this comment.
I think I had to remove this one as well to fix the warnings.
There was a problem hiding this comment.
Actually it works with it 😅
There was a problem hiding this comment.
And how about function.logarithmic? Is removing that truly needed? If present, what is the error?
| Built-in Frame Classes | ||
| ====================== | ||
|
|
||
| .. automodapi:: astropy.coordinates.builtin_frames |
There was a problem hiding this comment.
I guess a similar question here - certainly, with this removed, the section title should be removed too -- but this particular line is a very big deal in the actual docs!! https://docs.astropy.org/en/latest/coordinates/index.html#built-in-frame-classes
|
As discussed at infrastructure tag-up today (2022-04-07) between @saimn , @eteq , @bsipocz , @tomdonaldson , and myself, here is the plan:
Stretch goal: |
|
See sphinx-doc/sphinx#10348 (comment) for a great description of the problem and the different options to solve this. Closing, we should continue the discussion in astropy/sphinx-automodapi#130. |
Another attempt to fix #11725.
Description
This pull request is to address ...
Fixes #
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 CIlabel.no-changelog-entry-neededlabel. If this is a manual backport, use theskip-changelog-checkslabel unless special changelog handling is necessary.astropy-botcheck might be missing; do not let the green checkmark fool you.backport-X.Y.xlabel(s) before merge.