doc #603
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: Documentation | |
| run-name: doc | |
| env: | |
| PYTHON_VERSION: "3.13" | |
| POETRY_VERSION: "2.1.3" | |
| on: push | |
| jobs: | |
| sphinx: | |
| # Note that we only do this on one platform and with one Python version | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Init Python ${{ env.PYTHON_VERSION }} | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install and configure poetry ${{ env.POETRY_VERSION }} | |
| uses: hpcflow/github-support/setup-poetry@main | |
| with: | |
| version: ${{ env.POETRY_VERSION }} | |
| - name: Cache Virtual Environment | |
| uses: hpcflow/github-support/init-cache@main | |
| with: | |
| name: sphinx | |
| version: ${{ env.PYTHON_VERSION }} | |
| - name: Install Dependencies | |
| run: | | |
| poetry install --without pyinstaller | |
| - name: Configure Problem Matcher | |
| run: echo "::add-matcher::.github/problem-matchers/sphinx.json" | |
| # See: https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md | |
| # See: https://github.com/python/cpython/pull/20325 | |
| - name: Run Sphinx | |
| run: | | |
| poetry run make clean html | |
| working-directory: docs | |
| - name: Upload documentation artifact | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: matflow-documentation (${{ github.sha }}) | |
| path: docs/build/html | |
| if-no-files-found: error | |
| # TODO: Publish the docs to an internal site |