Test the docs #536
Open
Test the docs #536
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
clintonb
reviewed
Dec 3, 2024
Hello, this workflow runs against both PRs and on merge - see here It could be optimised by only running if the docs are changed or with better caching but docs building only takes 14 seconds, in parallel with slower jobs, including building dependencies - OK to merge as is? We can look at optimising the whole ci process separately if that is interesting. |
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.
dancergraham
force-pushed
the
add-docs-test
branch
from
376df88 to
92275b2
Compare
|
@clintonb could you look again please - I think this PR already does what you are asking for:
|
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.
Related to #526
update the CI workflow to include a documentation build stage.