Skip to content

Commit d2ec481

Browse files
committed
DOC: Re-platform documentation for the pixi build
1 parent 0b7d6ca commit d2ec481

13 files changed

Lines changed: 1249 additions & 408 deletions

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Summary
2+
3+
<!-- One or two sentences describing what this PR does and why. -->
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature / enhancement
9+
- [ ] Refactor / cleanup
10+
- [ ] Docs / CI only
11+
12+
## Checklist
13+
14+
- [ ] Pre-commit hooks pass locally (`pre-commit run --all-files`)
15+
- [ ] Tested wheel build on affected platform(s) (Linux / macOS / Windows)
16+
- [ ] Docs updated if behavior changed (`docs/`)
17+
- [ ] Commit messages use ITK prefixes (`BUG:`, `COMP:`, `DOC:`, `ENH:`, `PERF:`, `STYLE:`)
18+
19+
## Platform(s) Tested
20+
21+
<!-- Check all that apply, or note "untested" where applicable. -->
22+
- [ ] Linux x86_64 (manylinux)
23+
- [ ] Linux aarch64 (manylinux)
24+
- [ ] macOS arm64
25+
- [ ] Windows x86_64
26+
27+
## Related Issues
28+
29+
<!-- Closes #... -->

.github/workflows/docs.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: docs
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "docs/**"
7+
- ".readthedocs.yml"
8+
push:
9+
branches: [main]
10+
paths:
11+
- "docs/**"
12+
- ".readthedocs.yml"
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-python@v5
20+
with:
21+
python-version: "3.11"
22+
- name: Install dependencies
23+
run: pip install -r docs/requirements-docs.txt
24+
- name: Build docs
25+
run: sphinx-build -W --keep-going -b html docs docs/_build/html
26+
- uses: actions/upload-artifact@v4
27+
if: always()
28+
with:
29+
name: docs-html
30+
path: docs/_build/html
31+
retention-days: 7

.github/workflows/pre-commit.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: pre-commit
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v5
14+
with:
15+
python-version: "3.11"
16+
- uses: pre-commit/action@v3.0.1

.readthedocs.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.11"
7+
8+
sphinx:
9+
configuration: docs/conf.py
10+
11+
python:
12+
install:
13+
- requirements: docs/requirements-docs.txt

0 commit comments

Comments
 (0)