install instructinos #40
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: Deploy Documentation | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.12" # install the python version needed | |
| - name: install deps | |
| run: | | |
| apt-get update && apt-get install -y wget gcc | |
| pip install -r requirements.txt | |
| - name: build docs | |
| run: | | |
| PYTHONPATH=. mkdocs build | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: page | |
| path: site | |
| if-no-files-found: error | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build | |
| environment: | |
| name: github-pages | |
| url: ${{steps.deployment.outputs.page_url}} | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: page | |
| path: . | |
| - uses: actions/configure-pages@v1 | |
| - uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: . | |
| - id: deployment | |
| uses: actions/deploy-pages@v3 |