switch to mkdocs #184
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: CacheToolsUtils documentation publication on GitHub | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| - name: Install dependencies | |
| run: make venv | |
| - name: Check documentation syntax | |
| run: make check.docs | |
| - name: Generate documentation | |
| run: make docs | |
| - name: Fix permissions | |
| run: | | |
| find _site -type d -print | xargs chmod a+rx | |
| find _site -type f -print | xargs chmod a+r | |
| - name: Upload to GitHub Pages | |
| uses: actions/upload-pages-artifact@v3 | |
| deploy: | |
| # "Pages" must accept GitHub Actions as a source | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |