Fix missing docstring for low-k example #331
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: Docs | |
| on: push | |
| env: | |
| PYTHON_VERSION: '3.13' | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 25 | |
| steps: | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Print Python version | |
| run: python -V | |
| - name: Install LaTeX | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y cm-super dvipng fontconfig latexmk optipng texlive-latex-extra texlive-xetex fonts-freefont-otf xindy | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Load pip cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: .pip | |
| key: pip-${{ runner.os }}-${{ hashFiles('requirements.txt') }} | |
| restore-keys: | | |
| pip-${{ runner.os }}- | |
| pip- | |
| - name: Install requirements | |
| run: | | |
| pip --cache-dir=.pip install --upgrade pip wheel | |
| pip --cache-dir=.pip install -r requirements.txt -r requirements-dev.txt -r docs/requirements.txt | |
| - name: Generate reference data | |
| run: python3 pttools/bubble/fluid_reference.py | |
| env: | |
| PYTHONPATH: . | |
| - name: Generate documentation | |
| run: | | |
| cd docs | |
| make all | |
| - name: Upload results | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Documentation | |
| path: | | |
| docs/_build | |
| if-no-files-found: error |