diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b97d44b..973fe78 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,28 +1,55 @@ -name: docs +# Simple workflow for deploying static content to GitHub Pages +name: Build the docs on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab workflow_dispatch: - release: - types: [created] + +# 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 jobs: - publish: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 - with: - python-version: '3.11' - - name: prepare - run: cp ./README.md ./docs/. - - name: Install needed packages - run: | - python -m pip install --upgrade pip - pip install mkdocs "mkdocstrings[python]" - - name: build the docs - run: mkdocs build - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{secrets.GITHUB_TOKEN}} - publish_dir: ./site + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + - name: prepare + run: cp ./README.md ./docs/. + - name: Install needed packages + run: | + python -m pip install --upgrade pip + pip install mkdocs "mkdocstrings[python]" + - name: build the docs + run: mkdocs build + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4