| 1 |
name: Documentation building |
| 2 |
on: |
| 3 |
schedule: |
| 4 |
- cron: '0 0 * * 2' |
| 5 |
push: |
| 6 |
branches: |
| 7 |
- main |
| 8 |
pull_request: |
| 9 |
branches: |
| 10 |
- main |
| 11 |
paths: |
| 12 |
- .github/workflows/docs.yml |
| 13 |
- "cppy/**" |
| 14 |
- "docs/**" |
| 15 |
- setup.py |
| 16 |
- pyproject.toml |
| 17 |
|
| 18 |
jobs: |
| 19 |
docs: |
| 20 |
name: Docs building |
| 21 |
runs-on: ubuntu-latest |
| 22 |
steps: |
| 23 |
- uses: actions/checkout@v4 |
| 24 |
- name: Get history and tags for SCM versioning to work |
| 25 |
run: | |
| 26 |
git fetch --prune --unshallow |
| 27 |
git fetch --depth=1 origin +refs/tags/*:refs/tags/* |
| 28 |
- name: Set up Python |
| 29 |
uses: actions/setup-python@v5 |
| 30 |
- name: Install dependencies |
| 31 |
run: | |
| 32 |
python -m pip install --upgrade pip |
| 33 |
pip install -r docs/requirements.txt |
| 34 |
- name: Install project |
| 35 |
run: | |
| 36 |
pip install -e . |
| 37 |
- name: Install graphviz |
| 38 |
uses: ts-graphviz/setup-graphviz@v1 |
| 39 |
- name: Build documentation |
| 40 |
run: | |
| 41 |
mkdir docs_output; |
| 42 |
sphinx-build docs/source docs_output -W -b html; |