fix readthedocs (RTD) public docsite, modernize some of the docs build/testing #1119
Conversation
This file contains hidden or 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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1119 +/- ##
=======================================
Coverage 87.12% 87.12%
=======================================
Files 64 64
Lines 3162 3162
=======================================
Hits 2755 2755
Misses 407 407 |
|
All changes here only affect dev/tests,a nd the public docsite, no changes to the library. |
This was referenced Dec 30, 2023
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.
Fixes #1061
Resolves #1053
Resolves #1076
Closes #1109
I got added to the RTD maintainers and was able to update several settings, like our defualt branch.
I've also enabled pull request builds, so we can see when a PR would break RTD (or in the case of this PR, fixes it), and maintainers can also view the generated documentation which is nice.
Fixing the build involved updating a lot of outdated requirements, so I also moved all the requirements into poetry as described in #1053 .
Along the way, updated the extremely our-of-date
sphinxandsphinx-rtd-themeversions, so maybe the docs will even look a little nicer ✨.The requirements upgrades needed some changes throughout other test code to remove some deprecated things.
I didn't go as far as trying to untangle our custom doctest thing and remove that, there's enough in this PR already and I want to get the public docsite fixed. That work will probably be part of or a pre-requisite for trying to move doctests into pytest, described a bit in #1105 .