fix documentation #2
Workflow file for this run
This file contains hidden or 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: "Continuous Deployment" | |
| on: | |
| push: | |
| tags: | |
| - "*" | |
| jobs: | |
| ############################################################################# | |
| # Create and online deployment of the documentation ######################### | |
| docs: ####################################################################### | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Dependencies (pip) | |
| shell: bash | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install .[docs] | |
| - name: Build Documentation | |
| run: | | |
| make html | |
| working-directory: docs/ | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build/html | |
| allow_empty_commit: true | |
| ############################################################################# | |
| ## Publish the distribution to PyPI ######################################### | |
| distribution_pypi: ########################################################## | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install build | |
| run: >- | |
| python -m pip install build --user | |
| - name: Build a binary wheel and a source tarball | |
| run: >- | |
| python -m build --sdist --wheel --outdir dist/ . | |
| - name: Publish distribution to PyPI | |
| if: startsWith(github.ref, 'refs/tags') | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| password: ${{ secrets.PYPI_API_TOKEN }} | |
| ############################################################################# | |
| ## Create a public "Release" on the Github page ############################# | |
| release_github: ############################################################# | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: ncipollo/release-action@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} |