Skip to content

Commit 72f92d3

Browse files
committed
Add mkdocs site with API reference and GitHub Pages deployment
Set up mkdocs-material with mkdocstrings to auto-generate API docs from docstrings across all 18 api modules. Add GitHub Actions workflow to build and deploy to GitHub Pages on push to main.
1 parent 13e458b commit 72f92d3

22 files changed

Lines changed: 204 additions & 0 deletions

.github/workflows/docs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.12'
19+
- run: pip install mkdocs-material "mkdocstrings[python]"
20+
- run: mkdocs gh-deploy --force

docs/api/binaryop.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# BinaryOp
2+
3+
::: suitesparse_graphblas.api.binaryop

docs/api/container.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Container
2+
3+
::: suitesparse_graphblas.api.container

docs/api/context.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Context
2+
3+
::: suitesparse_graphblas.api.context

docs/api/descriptor.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Descriptor
2+
3+
::: suitesparse_graphblas.api.descriptor

docs/api/global_.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Global
2+
3+
::: suitesparse_graphblas.api.global_

docs/api/global_options.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Global Options
2+
3+
::: suitesparse_graphblas.api.global_options

docs/api/grb_type.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Type
2+
3+
::: suitesparse_graphblas.api.grb_type

docs/api/indexbinaryop.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# IndexBinaryOp
2+
3+
::: suitesparse_graphblas.api.indexbinaryop

docs/api/indexunaryop.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# IndexUnaryOp
2+
3+
::: suitesparse_graphblas.api.indexunaryop

0 commit comments

Comments
 (0)