Add the missing docs for v4.4.0 #255
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: Continuous Integration | |
| on: | |
| push: | |
| pull_request: | |
| jobs: | |
| unit-tests: | |
| name: Test on Python v${{ matrix.python-version }} | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| matrix: | |
| include: | |
| - pipenv-version: '2022.4.8' | |
| python-version: '3.6' | |
| - pipenv-version: '2022.4.8' | |
| python-version: '3.7' | |
| - pipenv-version: '2022.4.8' | |
| python-version: '3.8' | |
| - pipenv-version: '2022.4.8' | |
| python-version: '3.9' | |
| - pipenv-version: '2023.2.4' | |
| python-version: '3.10' | |
| - pipenv-version: '2023.2.4' | |
| python-version: '3.11' | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - name: Install build essentials | |
| run: sudo apt-get --yes install build-essential | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| pip install pipenv==${{ matrix.pipenv-version }} | |
| pipenv install --dev | |
| - run: pipenv run tests | |
| - run: pipenv run tests-coverage | |
| test-documentation: | |
| name: Test building the documentation | |
| if: github.ref != 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - name: Install build essentials | |
| run: sudo apt-get --yes install build-essential | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| - name: Install dependencies | |
| run: | | |
| pip install pipenv | |
| pipenv install --dev | |
| - name: Build the documentation | |
| run: pipenv run sphinx-build -b html -a -E -v docs/source docs/html | |
| publish-documentation: | |
| name: Build and publish the documentation | |
| if: github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - name: Install build essentials | |
| run: sudo apt-get --yes install build-essential | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| - name: Install dependencies | |
| run: | | |
| pip install pipenv | |
| pipenv install --dev | |
| - name: Build the documentation | |
| run: pipenv run sphinx-build -b html -a -E -v docs/source docs/html | |
| - name: Publish the documentation | |
| uses: JamesIves/github-pages-deploy-action@3.7.1 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: docs/html | |
| CLEAN: true | |
| publish-release: | |
| name: Publish the release | |
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - name: Install build essentials | |
| run: sudo apt-get --yes install build-essential | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| - name: Install dependencies | |
| run: | | |
| pip install pipenv | |
| pipenv install --dev | |
| - name: Create the distribution | |
| run: pipenv run python setup.py build sdist | |
| - name: Publish the distribution | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_TOKEN }} | |
| - name: Create the release | |
| id: create_release | |
| uses: actions/create-release@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| tag_name: ${{ github.ref }} | |
| release_name: Release ${{ github.ref }} | |