Skip to content

Standardise docs build: use __PKG_VERSION__, uv-based build.sh, minimal Makefile #3403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeromekelleher merged 1 commit into from
Feb 27, 2026
Merged

Standardise docs build: use __PKG_VERSION__, uv-based build.sh, minimal Makefile #3403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
BUILDDIR = _build
DOXYGEN_XML=doxygen/xml
BUILDDIR = _build
DOXYGEN_XML = doxygen/xml

all: ${DOXYGEN_XML} dev
all: ${DOXYGEN_XML}
./build.sh

${DOXYGEN_XML}: ../c/tskit/*.h
cd doxygen && doxygen

dev:
uv --project=../python run jupyter-book build -Wn --keep-going .

clean:
rm -fR $(BUILDDIR) $(DOXYGEN_XML)
2 changes: 1 addition & 1 deletion docs/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

REPORTDIR=_build/html/reports

jupyter-book build -Wn --keep-going .
uv run --project=../python --group docs jupyter-book build . -vnW --keep-going
RETVAL=$?
if [ $RETVAL -ne 0 ]; then
if [ -e $REPORTDIR ]; then
Expand Down