Fix Docs generation - Improve Pipeline#459
Merged
JonathanHuot merged 7 commits intomasterfrom Nov 11, 2021
Merged
Conversation
Idea is to put the control in the hands of developers to be sure they can validate all steps executed by Travis the exact same way
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add docs generation into tox. Took the opportunity to move Black Travis job into Tox as well.
To generate Sphinx (ReadTheDocs) locally, you can run
tox -e docsTo validate Readme syntax (used when publishing package into Pypi https://pypi.org/project/requests-oauthlib/ ), you can run
tox -e readmeTo validate code syntax, you can run
tox -e blackAlso fix #392 by adding a docutils 0.16 restriction which is blocking ReadTheDocs worker.