Extended documentaiton #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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| build-n-deploy: | |
| name: Build and deploy | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout code 🛎️ | |
| uses: actions/[email protected] | |
| with: | |
| persist-credentials: false | |
| - name: Set up Python 3.8 🐍 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.8 | |
| - name: Install dependencies 💾 | |
| run: | | |
| pip install -r requirements.txt | |
| pip install -r requirements-dev.txt | |
| - name: Build the documentation 🔧📖 | |
| run: | | |
| cd docs | |
| make html | |
| - name: Deploy 🚀 | |
| if: github.ref == 'refs/heads/master' | |
| uses: JamesIves/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: docs/build/html | |
| CLEAN: true |