-
-
Notifications
You must be signed in to change notification settings - Fork 259
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
Test all pull requests for docs #536
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be done for pull requests that touch docs. Finding a failure after merging to master is too late. Can you add a workflow that runs against PRs?
Hello, this workflow runs against both PRs and on merge - see here |
Related to jazzband#526 Add a command to build the documentation using Sphinx and update the CI workflow to include a documentation build stage. * **run.sh** - Add a command to build the documentation using Sphinx. - Update the usage function to include the new builddocs command. * **.github/workflows/python-package.yml** - Add a new stage to run the documentation building to ensure it works. - Update the release-production stage to depend on the new docs stage.
376df88
to
92275b2
Compare
@clintonb could you look again please - I think this PR already does what you are asking for:
|
Hi @clintonb I still think this PR does exactly what you are asking for - can you please rephrase if I'm missing something? |
This workflow runs against all PRs to catch problems with docs. It catches any problems before merging to master.
Related to #526
update the CI workflow to include a documentation build stage.