Enable nitpicky mode for sphinx and get docs to build cleanly #140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #140 +/- ##
==========================================
+ Coverage 70.09% 70.57% +0.47%
==========================================
Files 9 9
Lines 602 605 +3
==========================================
+ Hits 422 427 +5
+ Misses 180 178 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Closed
|
looks like the CI and RTD build all ran successfully 🥳 |
pllim
reviewed
Sep 13, 2022
pllim
reviewed
Sep 13, 2022
Co-authored-by: P. L. Lim <[email protected]>
Co-authored-by: P. L. Lim <[email protected]>
Co-authored-by: P. L. Lim <[email protected]>
Co-authored-by: P. L. Lim <[email protected]>
pllim
reviewed
Sep 13, 2022
pllim
reviewed
Sep 13, 2022
|
i think this is ready to merge and @pllim has approved it. if there are no further comments or suggestions, i will go ahead and merge at the end of the day. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As @pllim noted, there were a lot of warnings in the documentation build. This PR enables
nitpickymode insphinxand makes the fixes necessary to get the documentation to build cleanly. There was quite a bit of malformedrstscattered about. I had to add exceptions tospecutils.Spectrum1Dbecause the cross-referencing to that package wasn't working for some reason. Cross-references toastropyandnumpywork so it's something specific tospecutils. AFAICT, this is an issue seen elsewhere in theastropyecosystem so it looks like asphinxquirk/bug to be worked around.This can be tested locally by running
tox -e build_docs. Need to run through CI to make sure that flows through properly to RTD...