Skip to content

fixup docs #2507

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 3 commits into from
Feb 27, 2026
Merged

fixup docs #2507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6826228
Standardise docs build: use __PKG_VERSION__, uv-based build.sh, minim…
jeromekelleher Feb 27, 2026
30f9e54
Update min_python_version to 3.11
jeromekelleher Feb 27, 2026
14fd124
Use --group instead of --only-group in build.sh
jeromekelleher Feb 27, 2026
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
15 changes: 2 additions & 13 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@

# Need to set PYTHONPATH so that we pick up the local msprime
PYPATH=${PWD}/..
MSP_VERSION:=$(shell PYTHONPATH=${PYPATH} \
python3 -c 'import msprime; print(msprime.__version__.split("+")[0])')

dev:
PYTHONPATH=${PYPATH} ./build.sh

dist:
@echo Building distribution for msprime version ${MSP_VERSION}
sed -i s/__MSPRIME_VERSION__/${MSP_VERSION}/g _config.yml
PYTHONPATH=${PYPATH} ./build.sh
all:
./build.sh

clean:
rm -fR _build
4 changes: 2 additions & 2 deletions docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ sphinx:
navigation_with_keys: false
pygments_dark_style: monokai
logo:
text: "Version __MSPRIME_VERSION__"
text: "Version __PKG_VERSION__"
myst_enable_extensions:
- colon_fence
- deflist
Expand Down Expand Up @@ -70,4 +70,4 @@ sphinx:
autodoc_typehints: none

myst_substitutions:
min_python_version: "3.10"
min_python_version: "3.11"
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 -nW --keep-going .
uv run --project=.. --group docs jupyter-book build . -vnW --keep-going
RETVAL=$?
if [ $RETVAL -ne 0 ]; then
if [ -e $REPORTDIR ]; then
Expand Down