Astroquery doc fixes#269
Conversation
The actual problem is that there was no whitespace, although I've moved it to the end for clarity
Automodapi's headings have to be consistent with the rest of the page, so either use the =-^ sequence it uses, or use the ":headings:" directive of automodapi. I did the former because it makes things more consistent with astropy.
astropy.sphinx.conf in the astropy core package adds a n astropy_ link, so having *another* one here was triggering a warning
|
@keflavich @cdeil @mirochaj (these are the main people who edited the files I adjusted here) - if you like, you might want to glance over these changes. They are mostly fiddly little sphinx quirks that aren't at all obvious, so that way you'll know to avoid these sort of things in the future. |
There was a problem hiding this comment.
Is there a change here? It's probably not important, but I'd like to understand.
There was a problem hiding this comment.
Nothing terribly important - my editor automatically removes trailing
whitespace from the end of lines, and that's what's happening here.
In docs/api.rst:
for obj,r in zip(['m31','m51','m17'],['1"','1"','1"'])]-.. TODO::
+.. TODO::
+Is there a change here? It's probably not important, but I'd like to
understand.—
Reply to this email directly or view it on GitHubhttps://github.com//pull/269/files#r8656369
.
|
@eteq: Yes, I had avoided including the sphinx-doc warnings in the tests because I never got them to green; each subtle warning takes quite a lot of time for me to pin down. |
This PR contains a variety of fixes that get rid of the 11 current warnings astroquery throws when you build the docs.
@keflavich - now that the docs are passing, perhaps there should be a test added that runs the sphinx docs and fails if warnings are issued (like in the main Astropy repo)? That will keep minor errors like those fixed here from creeping in.