Update myst-parser[linkify] requirement from <2.1,>=1 to >=1,<3.1 in … #48
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
| name: "📚 Documentation Builder" | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| - "docs/**/*" | |
| - "requirements/documentation.txt" | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| env: | |
| PYTHON_VERSION: 3.9 | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get source code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| cache: "pip" | |
| cache-dependency-path: "requirements/documentation.txt" | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Cache Sphinx cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: docs/_build/cache | |
| key: ${{ runner.os }}-sphinx-${{ hashFiles('docs/**/*') }} | |
| restore-keys: | | |
| ${{ runner.os }}-sphinx- | |
| - name: Install project requirements | |
| run: | | |
| python -m pip install -U pip setuptools wheel | |
| python -m pip install -U -r requirements/documentation.txt | |
| - name: Build doc using Sphinx | |
| run: sphinx-build -b html -j auto -d docs/_build/cache -q docs docs/_build/html | |
| - name: Save build doc as artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation | |
| path: docs/_build/html/* | |
| if-no-files-found: error | |
| retention-days: 30 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| if: ${{ github.event_name == 'push' && ( startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' ) }} | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| if: ${{ github.event_name == 'push' && ( startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' ) }} | |
| with: | |
| # Upload entire repository | |
| path: docs/_build/html/ | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| if: ${{ github.event_name == 'push' && ( startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' ) }} | |
| uses: actions/deploy-pages@v4 |