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.

Sign up for GitHub

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

Jump to bottom

Integrate the documentation generation into the CI pipeline #4

Open
tbenthompson opened this issue Apr 5, 2021 · 1 comment
Open

Integrate the documentation generation into the CI pipeline #4

tbenthompson opened this issue Apr 5, 2021 · 1 comment

Comments

@tbenthompson
Copy link
Owner

It's not a perfect fit because the generated readme needs to be in the git repo but I don't want to be committing from the CI server. One solution is to have the CI generate the readme and if there's any diff with the existing readme, then fail the tests. Another solution would be to have the same check in pre-commit.
@tbenthompson
Copy link
Owner Author

I just noticed that the example.py code was out of date with respect to the rest of the package and that was causing bugs. Catching this earlier via CI would be nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tbenthompson