updated documentation for loading python module #11
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: verify-sphinx-doc-generation | |
| on: | |
| push: | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| jobs: | |
| build-and-test: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout IDStools sources | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| # until saxonche is available in 3.13 | |
| # https://saxonica.plan.io/issues/6561 | |
| python-version: "<3.13" | |
| - name: Display Python version | |
| run: python -c "import sys; print(sys.version)" | |
| - name: Install build dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel build | |
| - name: Build package | |
| run: | | |
| rm -rf dist | |
| python -m build . | |
| - name: Install package and dependencies | |
| run: | | |
| pip install "$(readlink -f dist/*.whl)[docs]" | |
| - name: Debug dependencies | |
| run: | | |
| pip freeze | |
| - name: Build Sphinx documentation | |
| run: | | |
| export SPHINXOPTS='-W -n --keep-going' | |
| make -C docs realclean autogen html man | |
| - name: Upload Sphinx documentation as artifact | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: sphinx-documentation | |
| path: docs/build/html/ | |
| retention-days: 30 | |
| if-no-files-found: warn |