Merge pull request #5 from VCTLabs/doc-test #11
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: Docs | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - develop | |
| - master | |
| jobs: | |
| build: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.9' | |
| - name: Add python requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install tox | |
| - name: Build docs | |
| run: | | |
| tox -e docs | |
| - uses: actions/upload-artifact@v2 | |
| with: | |
| name: ApiDocsHTML | |
| path: "docs/_build/html/" | |
| - name: set nojekyll for github | |
| run: | | |
| sudo touch docs/_build/html/.nojekyll | |
| - name: Deploy docs to gh-pages | |
| if: ${{ github.event_name == 'push' }} | |
| uses: JamesIves/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: docs/_build/html/ | |
| SINGLE_COMMIT: true |