Publish Documentation to GitHub Pages #636
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: Publish Documentation to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - 'main' # when someone pushes to the 'main' branch | |
| schedule: | |
| - cron: '59 3 * * *' # this triggers deployment every night at 3:59 UTC / 23:59 EST | |
| workflow_dispatch: # this allows us to run it manually | |
| release: | |
| types: [released] # only deploy when we make a new `latest` release | |
| permissions: | |
| contents: write | |
| jobs: | |
| publish: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: pip install -U ".[docs]" | |
| - run: mkdocs gh-deploy --force |