iframe-proxy | Sunbelt Computer Software

47 lines (43 loc) · 1.39 KB

name: Build docs
on: [push, pull_request]
permissions:
  contents: read
    runs-on: ubuntu-latest
    - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
      with:
        persist-credentials: false
    - name: Set up Python
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
      with:
        python-version: 3.x
        cache: pip
        cache-dependency-path: |
          docs/requirements.txt
          pyproject.toml
    - name: Install uv
      uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
    - name: Install Graphviz
      run: |
        sudo apt-get update
        sudo apt-get install graphviz
    - name: Install Python dependencies
      run: |
        uv pip install --system setuptools coverage rstvalidator
        uv pip install --system -r docs/requirements.txt
    - name: Build docs
      run: |
        python -m rstvalidator long_description.rst
        python tools/fixup_whats_new_pr.py
        make -C docs/ html SPHINXOPTS="-W" \
          PYTHON="coverage run -a" \
          SPHINXBUILD="coverage run -a -m sphinx.cmd.build"
    - name: Generate coverage xml
      run: |
        coverage combine `find . -name .coverage\*` && coverage xml
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6
      with:
        name: Docs

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Uh oh!

FilesExpand file tree

docs.yml

Latest commit

History

docs.yml

File metadata and controls