docs: fix docs build, fix all build warnings, enable strict mode #71
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
msschwartz21
approved these changes
Oct 31, 2023
|
cool. RTD previews on PRs are running now... you can see the latest preview at https://traccuracy--71.org.readthedocs.build/en/71/ |
|
@tlambert03 Now that I merged the coverage and precommit PRs, we have conflicts in the pyproject.toml. Can you resolve when you get the chance? Thanks! |
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## main #71 +/- ##
=======================================
Coverage 83.01% 83.01%
=======================================
Files 18 18
Lines 848 848
=======================================
Hits 704 704
Misses 144 144
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
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.
This fixes #67 and gets docs building again. I did it by playing around with dependencies, and ultimately found that updating everything to the newest versions worked best (I removed m2r2 in favor of
myst-parser, which helped with one of the docutils conflicts... I believe myst is now the recommended way to incorporate markdown in rst sources).I would be curious to hear from @cmalinmayor whether the list rendering bug that necessitated the pins in 3b0be12 is "back" with this PR... but I wasn't able to find anything weird looking? bullets seem fine?
I did hard pin everything in the docs deps, which is optional and can be undone if you prefer, but I don't hesitate to pin all my docs requirements if I feel like it is a possibly fragile blend of packages. It's not like your regular dependencies (and you don't want to be surprised by a breakage) and you can update at your leisure if there's a feature you later want.
I went through and got rid of all the remaining warnings in the docs build (mostly indentations and unescaped
*characters, and then enabledfail_on_warning: trueto prevent them from leaking back in. That too can be undone if you like.If you're willing, it might be nice to enable readthedocs builds on PRs, so you can test this (and future PRs). Instructions here: https://docs.readthedocs.io/en/stable/pull-requests.html (needs to be done by someone with rtd admin)