diff options
| author | John L. Villalovos <john@sodarock.com> | 2021-12-22 15:22:40 -0800 |
|---|---|---|
| committer | John L. Villalovos <john@sodarock.com> | 2021-12-22 15:22:40 -0800 |
| commit | 85b43ae4a96b72e2f29e36a0aca5321ed78f28d2 (patch) | |
| tree | 73d2c0d49e08d37b60183faff7e9b10a7e83171b | |
| parent | 83dcabf3b04af63318c981317778f74857279909 (diff) | |
| download | gitlab-jlvillal/doc_artifacts.tar.gz | |
chore: generate artifacts for the docs build in the CIjlvillal/doc_artifacts
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.
| -rw-r--r-- | .github/workflows/docs.yml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c635be4..05ccb90 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -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 |