Skip to content

Commit a0a1551

Browse files
committed
Switch docs from mkdocs to pdoc for proper doctest rendering
mkdocstrings rendered doctest blocks as inline text. pdoc natively renders >>> blocks as syntax-highlighted code. Docs are now generated inside the Docker container via pdoc and deployed to GitHub Pages.
1 parent 72f92d3 commit a0a1551

22 files changed

Lines changed: 35 additions & 188 deletions

.github/workflows/docs.yml

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,43 @@ on:
66
workflow_dispatch:
77

88
permissions:
9-
contents: write
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
1015

1116
jobs:
12-
deploy:
17+
build:
1318
runs-on: ubuntu-latest
1419
steps:
1520
- uses: actions/checkout@v4
16-
- uses: actions/setup-python@v5
21+
22+
- name: Build package in Docker
23+
run: |
24+
docker build --target psg \
25+
--build-arg SUITESPARSE=v$(cat GB_VERSION.txt) \
26+
--build-arg VERSION=99.0.0.0 \
27+
-t psg-docs .
28+
29+
- name: Generate docs with pdoc
30+
run: |
31+
docker run --rm -v ${{ github.workspace }}/site:/out psg-docs \
32+
bash -c "pip install --break-system-packages -q pdoc && \
33+
pdoc --output-directory /out --no-show-source --docformat numpy \
34+
suitesparse_graphblas.api"
35+
36+
- uses: actions/upload-pages-artifact@v3
1737
with:
18-
python-version: '3.12'
19-
- run: pip install mkdocs-material "mkdocstrings[python]"
20-
- run: mkdocs gh-deploy --force
38+
path: site/
39+
40+
deploy:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
steps:
47+
- uses: actions/deploy-pages@v4
48+
id: deployment

docs/api/binaryop.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/container.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/context.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/descriptor.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/global_.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/global_options.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/grb_type.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/indexbinaryop.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/api/indexunaryop.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)