Skip to content

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

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

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec10a31
Standardise docs build: use __PKG_VERSION__, uv-based build.sh, minim…
jeromekelleher Feb 27, 2026
d0f0879
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 tstrait
PYPATH=${PWD}/..
TSTRAIT_VERSION:=$(shell PYTHONPATH=${PYPATH} \
python3 -c 'import tstrait; print(tstrait.__version__.split("+")[0])')

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

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

clean:
rm -fR _build
2 changes: 1 addition & 1 deletion docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ sphinx:
logo:
text: |
tstrait<br/>
version __TSTRAIT_VERSION__
version __PKG_VERSION__
myst_enable_extensions:
- colon_fence
- deflist
Expand Down
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