--- a +++ b/.github/workflows/docs.yml @@ -0,0 +1,56 @@ +name: website + +# build the documentation whenever there are new commits on main +on: + push: + branches: + - main + # Alternative: only build for tags. + # tags: + # - '*' + +# security: restrict permissions for CI jobs. +permissions: + contents: read + +jobs: + # Build the documentation and upload the static HTML files as an artifact. + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + # ADJUST THIS: install all dependencies (including pdoc) + - name: Install dependencies + run: make requirements dev + # ADJUST THIS: build your documentation into docs/. + - name: Build documentation + run: make docs + # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. + - name: Package documentation + run: tar --directory docs/ -hcf artifact.tar . + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: github-pages + path: ./artifact.tar + + # Deploy the artifact to GitHub pages. + # This is a separate job so that only actions/deploy-pages has the necessary permissions. + deploy: + needs: build + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file