Update README.md #119
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: generate docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| workflow_dispatch: | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@master | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install Poetry | |
| run: pip install poetry | |
| - name: install | |
| working-directory: backend/src | |
| run: poetry install | |
| - name: Build documentation | |
| working-directory: backend/src | |
| run: | | |
| poetry run mkdocs build -f ../../mkdocs.yml | |
| - name: Copy site | |
| run: | | |
| mkdir -p gh-pages | |
| touch gh-pages/.nojekyll | |
| cp -r _site/* gh-pages | |
| - name: Deploy documentation | |
| if: ${{ github.event_name == 'push' }} | |
| uses: JamesIves/github-pages-deploy-action@4.1.4 | |
| with: | |
| branch: gh-pages | |
| folder: gh-pages | |
| clean-exclude: | | |
| coverage/* |