Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Docs generation - Improve Pipeline #459

Merged
merged 7 commits into from Nov 11, 2021
Merged

Fix Docs generation - Improve Pipeline #459

merged 7 commits into from Nov 11, 2021

Conversation

JonathanHuot
Copy link
Contributor

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 docs
To validate Readme syntax (used when publishing package into Pypi https://pypi.org/project/requests-oauthlib/ ), you can run tox -e readme
To validate code syntax, you can run tox -e black

Also fix #392 by adding a docutils 0.16 restriction which is blocking ReadTheDocs worker.

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
@JonathanHuot JonathanHuot merged commit f3bebb5 into master Nov 11, 2021
@JonathanHuot JonathanHuot deleted the tox-docs branch November 11, 2021 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Read the Docs is out of sync.
1 participant