🔥 Remove CHANGELOG.md, refer to the GitHub releases
#57
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - main | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| name: "Build" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| name: "📥 Checkout" | |
| - uses: actions/setup-python@v4 | |
| name: "✨ Set up Python" | |
| id: "setup-python" | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v3 | |
| name: "🗃 Cache" | |
| with: | |
| key: "${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-mkdocs" | |
| path: | | |
| ~/.cache | |
| .cache | |
| .venv | |
| - name: "📥 Install Material for MkDocs" | |
| run: | | |
| python -m venv .venv | |
| .venv/bin/pip install --upgrade 'mkdocs-material~=9.0' 'mkdocs-autorefs~=0.4' 'mkdocstrings[python]~=0.20' 'mkdocs-git-revision-date-localized-plugin~=1.1' pillow cairosvg | |
| - run: ".venv/bin/mkdocs build --site-dir _site" | |
| name: "📦 Build" | |
| - name: "📤 Upload" | |
| uses: actions/upload-pages-artifact@v1 | |
| deploy: | |
| name: "Deploy" | |
| runs-on: ubuntu-latest | |
| needs: "build" | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: "✨ Deploy" | |
| uses: actions/deploy-pages@v1 |