setting up gh build and publish to gh-pages workflow #1
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 | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - docs | ||
| - src | ||
| - README.md | ||
| jobs: | ||
| docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-python@v2 | ||
| - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocstrings | ||
| - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com' | ||
| - name: Publish docs | ||
| run: mkdocs gh-deploy | ||
