From addc507723a9cf5320e1acb58d53ebb2b1c5e9f7 Mon Sep 17 00:00:00 2001 From: Sean Anderson Date: Sun, 19 Nov 2023 19:27:36 -0500 Subject: [PATCH] ci: Build/deploy documentation Add a CI job to build and deploy our API documentation. Signed-off-by: Sean Anderson --- .github/workflows/doc.yml | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/doc.yml diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..b4857c3 --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,39 @@ +name: Build and deploy documentation + +on: + push: + branches: + - master + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - run: pip install sphinx . + - uses: actions/configure-pages@v2 + - run: make htmldocs + - uses: action/upload-pages-artifact@v1 + with: + path: doc/out/html + + deploy: + needs: build + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - id: deployment + uses: actions/deploy-pages@v1