Repair docs build #91
Merged
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
This updates a number of dev dependencies related to docs and pins them appropriately so we don't have future problems like the one that prompted this (an update to Jinja2 broke). There are still some unpinned dev dependencies that I should add constraints to in a follow-up commit.
Mr0grog
force-pushed
the
repair-docs-build
branch
from
1fb1b24
to
f7ebf88
Compare
They just deprecated the old way to specify versions but didn't raise a warning about it, and the error message is a lie if you use the deprecated property. Yeesh.
Since we are only installing in places where it's ok.
|
Sheesh! Between the Sphinx vs. Flake8 compatibility issue, getting the new-ish features we want, and incorrect error messages from Read The Docs, this was a lot messier than I expected! At least we have more tightly constrained versions that should be less likely to break. (If we have future issues, it may be time to just pin specific versions.) |
Closed
Mr0grog
added a commit
to edgi-govdata-archiving/web-monitoring-diff
that referenced
this pull request
Oct 3, 2022
On Python versions earlier than 3.10, flake8 and Sphinx are just not going to be compatible, and need to be in separate groups so both don't have to be installed at the same time or in the same environment. This also updates our ReadTheDocs setup to use their newer configuration file format. Overall, this follows the arrangement I set up for the Wayback package in edgi-govdata-archiving/wayback#91.
Mr0grog
added a commit
to edgi-govdata-archiving/web-monitoring-diff
that referenced
this pull request
Oct 3, 2022
On Python versions earlier than 3.10, flake8 and Sphinx are just not going to be compatible, and need to be in separate groups so both don't have to be installed at the same time or in the same environment. This also updates our ReadTheDocs setup to use their newer configuration file format. Overall, this follows the arrangement I set up for the Wayback package in edgi-govdata-archiving/wayback#91.
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 takes over for #90 and sets appropriate, working constraints on all the dev dependencies involved in building docs (we should really set constraints on all the dev dependencies, but this is at least an improvement). I should get the docs building correctly again, and also takes advantage of new features in the docs tools we use (like a new recommended syntax for defaults in numpydoc!).