From 3a0223f7bc65d444f6044acc223c82191a681a72 Mon Sep 17 00:00:00 2001 From: CJ Steiner Date: Sat, 18 Jan 2025 02:53:05 -0600 Subject: [PATCH] add in workflow to publish docs --- .github/workflows/build-docs.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 00000000..e7cb4c27 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,29 @@ +name: Sphinx build + +on: # yamllint disable-line rule:truthy + workflow_call: + +jobs: + sphinx-build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./doc + steps: + - uses: actions/checkout@v4 + + - name: Build HTML + run: make + + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: ./html/ + + - name: Deploy + if: ${{ github.ref == 'refs/heads/master' }} + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./html