docs updates #82
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
| # GitHub Actions workflow for testing and continuous integration. | |
| # | |
| # This file performs testing using tox and tox.ini to define and configure the test environments. | |
| name: CI Tests | |
| on: | |
| push: | |
| branches: | |
| - main # GitHub now defaults to 'main' as the name of the primary branch. Change this as needed. | |
| pull_request: | |
| branches: # only build on PRs against 'main' if you need to further limit when CI is run. | |
| - main | |
| jobs: | |
| # Github Actions supports ubuntu, windows, and macos virtual environments: | |
| # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners | |
| ci_tests: | |
| name: ${{ matrix.name }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| include: | |
| - name: Code style checks | |
| os: ubuntu-latest | |
| python: 3.x | |
| toxenv: codestyle | |
| - name: Python 3.11 with minimal dependencies | |
| os: ubuntu-latest | |
| python: 3.11 | |
| toxenv: py311-test | |
| - name: Python 3.11 with latest dev versions of key dependencies | |
| os: ubuntu-latest | |
| python: 3.11 | |
| toxenv: py311-test-devdeps | |
| - name: Test building of Sphinx docs | |
| os: ubuntu-latest | |
| python: 3.x | |
| toxenv: build_docs | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up python ${{ matrix.python }} on ${{ matrix.os }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Add conda to system path | |
| run: | | |
| # $CONDA is an environment variable pointing to the root of the miniconda directory | |
| echo $CONDA/bin >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: | | |
| source $CONDA/etc/profile.d/conda.sh | |
| conda env update --file environment.yml --name base | |
| - name: Install base dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install tox codecov | |
| - name: Install graphviz dependency | |
| if: ${{ contains(matrix.toxenv, 'build_docs') }} | |
| run: sudo apt-get -y install graphviz | |
| - name: Test with tox | |
| run: | | |
| tox -e ${{ matrix.toxenv }} |