docs: add nitpicks#16482
Conversation
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
4508538 to
95d4aa5
Compare
3db4715 to
9aecfe1
Compare
|
Gosh, this is pretty awful. Given the strange build history, is it instead sphinx version dependent? Might it be better to just revert? (I.e., #16481) |
Yeah, not great. Maybe more
Perhaps. Where in RTD can we see what version it was picking up?
I hope not. What #15852 was doing was good. It would be a shame to revert that because of public API confusion. My suggestion would be to merge this PR then figure out how to revert THIS PR by either |
|
#15852 removed link targets in our documentation (by adding the Lines 112 to 114 in f3e40c0 The fix attempted here is not good because the documentation is now lacking links that were there before (compare the documentation for this pull request with the documentation for 6.1.0). @nstarman might have identified the correct fix in #16473, but I don't expect that to be applied quickly, so in the short term we will have to merge #16481. |
|
👎 to disable nitpicky. It has been useful in the past to catch real problems. Disabling it would be throwing out baby with the bath water. |
You have to click on "raw log" link on the build job page to see everything. |
Fixes #16481.
There's going to be a lot of nitpicks added. IDK why #15852 seemed to trigger new sphinx complaints.
But more strangely, if you look at the build history of RTD after #15852 was merged it worked just fine. It was only after #16475 was merged that RTD started complaining. But #16475 doesn't appear to be related.
This is a brittle solution.