diff --git a/.github/workflows/pdoc b/.github/workflows/pdoc new file mode 100644 index 0000000..33a7af6 --- /dev/null +++ b/.github/workflows/pdoc @@ -0,0 +1,47 @@ +name: pdoc + +# build the documentation whenever there are new commits on main +on: + push: + branches: + - master + # 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@v3 + - uses: actions/setup-python@v3 + + # ADJUST THIS: install all dependencies (including pdoc) + - run: pip install -r requirements.txt + # ADJUST THIS: build your documentation into docs/. + # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. + - run: pdoc -o docs -t docs/pdoc-dark-mode tessa + + - uses: actions/upload-pages-artifact@v1 + with: + path: docs/ + + # 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: + - id: deployment + uses: actions/deploy-pages@v1