DOC: add a doctest step to CI to allow writing testable code blocs, fix existing docstring code examples errors #2
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: Documentation tests | |
| on: | |
| push: | |
| branches: | |
| -dev | |
| -main | |
| -master | |
| pull_request: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Git clone | |
| uses: actions/checkout@v2 | |
| - name: Set up virtual environment | |
| uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| python-version: "3.11" | |
| environment-file: environment.doc.yml | |
| channels: defaults, conda-forge | |
| miniconda-version: "latest" | |
| - name: Install numpy | |
| run: conda install numpy=1.25.2 | |
| - name: Test doc | |
| run: cd doc && make doctest |