Improve documentation #121
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: CI | |
| on: | |
| push: | |
| branches: [ development ] | |
| pull_request: | |
| branches: [ main, development ] | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ windows-latest, macOS-latest, ubuntu-latest ] | |
| python: [ "3.8", "3.9", "3.10", "3.11" ] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Initialize Python ${{ matrix.python }} | |
| uses: actions/setup-python@v4.3.1 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install hpo-toolkit | |
| run: | | |
| python3 -m pip install .[test,docs] | |
| - name: Run tests | |
| run: | | |
| python3 -m unittest discover -s src -p _test*.py | |
| python3 -m unittest discover -s tests | |
| - name: Run documentation tests | |
| run: | | |
| cd docs | |
| sphinx-apidoc --separate --module-first -d 2 -H "API reference" -o apidocs ../src/hpotk | |
| make doctest |