apply readability suggestions from code review #165
Workflow file for this run
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 Documentation | |
| on: | |
| - push | |
| - pull_request | |
| jobs: | |
| generate: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Build Docs | |
| run: | | |
| sudo apt install -y python3-sphinx python3-sphinx-rtd-theme python3-ldap3 | |
| sudo pip install addict | |
| make -C docs html SPHINXOPTS="-W --keep-going" | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| name: documentation | |
| path: docs/build/html | |
| deploy: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| if: startsWith(github.ref, 'refs/tags') | |
| needs: generate | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy Pages artifact on tag | |
| id: deployment | |
| uses: actions/deploy-pages@v1 | |
| with: | |
| artifact_name: documentation |