From 85b43ae4a96b72e2f29e36a0aca5321ed78f28d2 Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Wed, 22 Dec 2021 15:22:40 -0800 Subject: [PATCH] chore: generate artifacts for the docs build in the CI 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. --- .github/workflows/docs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c635be4cc..05ccb9065 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