diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 00000000..a8c0b3a0 --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -0,0 +1,76 @@ +name: Deploy docs webpage + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + pull_request: + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +defaults: + run: + shell: bash + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Install Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install poetry + uses: abatilo/actions-poetry@v2 + + - uses: actions/cache@v3 + name: Define a cache for the virtual environment based on the dependencies lock file + with: + path: ./.venv + key: venv-${{ hashFiles('poetry.lock') }} + + - name: Fix lock? + run: poetry lock + + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + + - name: Install the project dependencies + run: poetry install --all-extras + + - name: Build the documentation + run: poetry run make docs + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: ./docs/build/html + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + if: github.ref == 'refs/heads/main' + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..57d339d7 --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +docs: + cd docs && make html + +.PHONY: docs \ No newline at end of file