chore: generate artifacts for the docs build in the CI #1774
Conversation
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
When building the docs store the created documentation as an artifact so that it can be viewed. This will create a html-docs.zip file which can be downloaded containing the contents of the `build/sphinx/html/` directory. It can be downloaded, extracted, and then viewed. This can be useful in reviewing changes to the documentation. See https://github.com/actions/upload-artifact for more information on how this works.
ac643fe to
85b43ae
Compare
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.
When building the docs store the created documentation as an artifact
so that it can be viewed.
This will create a html-docs.zip file which can be downloaded
containing the contents of the
build/sphinx/html/directory. It canbe downloaded, extracted, and then viewed. This can be useful in
reviewing changes to the documentation.
See https://github.com/actions/upload-artifact for more information on
how this works.