Skip to content

Commit

Permalink
chore: generate artifacts for the docs build in the CI
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
JohnVillalovos committed Dec 22, 2021
1 parent 83dcabf commit 85b43ae
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/docs.yml
Expand Up @@ -33,6 +33,11 @@ jobs:
env:
TOXENV: docs
run: tox
- name: Archive generated docs
uses: actions/upload-artifact@v2
with:
name: html-docs
path: build/sphinx/html/

twine-check:
runs-on: ubuntu-20.04
Expand Down

0 comments on commit 85b43ae

Please sign in to comment.