update docs ci #2
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: Build Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "v*" | |
| jobs: | |
| deploy: | |
| name: Deploy Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: 🐍 Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache-dependency-path: "pyproject.toml" | |
| cache: "pip" | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install -U pip | |
| python -m pip install .[dev2] | |
| python -m pip install .[docs] | |
| - name: 📚 Build Docs | |
| run: mkdocs build --clean | |
| # If something goes wrong with --pre tests, we can open an issue in the repo | |
| - name: Deploy Docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| personal_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./public |