Update README.md #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Workflow for building and deploying a MkDocs site to GitHub Pages | |
| name: Deploy MkDocs with GitHub Pages dependencies preinstalled | |
| on: | |
| # Runs on PR/pushes targeting the default branch | |
| pull_request: | |
| branches: | |
| - "main" | |
| paths: | |
| - "docsource/**" | |
| push: | |
| branches: | |
| - "main" | |
| paths: | |
| - "docsource/**" | |
| # 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 | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install required packages | |
| run: pip install -U mkdocs "mkdocstrings[python]" mkdocs-material pymdown-extensions | |
| - name: Build site (_site directory name is used for Jekyll compatiblity) | |
| run: mkdocs build --config-file ./mkdocs.yml --strict --site-dir ./_site | |
| env: | |
| CI: true | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |