Skip to content

Commit cf881f5

Browse files
committed
Use Jupyter Book for documentation.
1 parent 7aa32fe commit cf881f5

File tree

13 files changed

+1191
-728
lines changed

13 files changed

+1191
-728
lines changed

.readthedocs.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
version: 2
33
build:
4-
os: ubuntu-lts-latest
4+
os: ubuntu-24.04
55
tools:
66
python: '3.13'
77
jobs:
@@ -13,4 +13,9 @@ build:
1313
- pixi install -e docs
1414
build:
1515
html:
16-
- pixi run -e docs sphinx-build -T -b html docs/source $READTHEDOCS_OUTPUT/html
16+
- pixi run -e docs docs
17+
post_build:
18+
# Jupyter Book 2.0 builds site content to _build/html.
19+
# For ReadTheDocs, we build and then copy to the expected output location.
20+
- mkdir --parents $READTHEDOCS_OUTPUT/html/
21+
- cp -r docs/source/_build/html/* $READTHEDOCS_OUTPUT/html/

docs/Makefile

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

docs/make.bat

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

docs/source/build-docs.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash
2+
set -e
3+
4+
if [ -n "$READTHEDOCS_LANGUAGE" ] && [ -n "$READTHEDOCS_VERSION" ]; then
5+
export BASE_URL="/$READTHEDOCS_LANGUAGE/$READTHEDOCS_VERSION"
6+
fi
7+
8+
jupyter book build --html

docs/source/conf.py

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

0 commit comments

Comments
 (0)