58 lines
1.9 KiB
Makefile
58 lines
1.9 KiB
Makefile
# Minimal Makefile for Sphinx documentation
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= sphinx-build
|
|
SPHINXAUTOBUILD ?= sphinx-autobuild
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
PORT ?= 8003
|
|
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@echo ""
|
|
@echo "Additional targets:"
|
|
@echo " serve to build and serve documentation with auto-build and live reload"
|
|
|
|
# Compile Notebook files and record execution time
|
|
compile:
|
|
@set -e; \
|
|
echo "Starting Notebook compilation..."; \
|
|
mkdir -p logs; \
|
|
echo "Notebook execution timings:" > logs/timing.log; \
|
|
START_TOTAL=$$(date +%s); \
|
|
find $(SOURCEDIR) -path "*/_build/*" -prune -o -name "*.ipynb" -print0 | \
|
|
parallel -0 -j3 --halt soon,fail=1 ' \
|
|
NB_NAME=$$(basename {}); \
|
|
START_TIME=$$(date +%s); \
|
|
retry --delay=0 --times=3 -- \
|
|
jupyter nbconvert --to notebook --execute --inplace "{}" \
|
|
--ExecutePreprocessor.timeout=600 \
|
|
--ExecutePreprocessor.kernel_name=python3; \
|
|
RET_CODE=$$?; \
|
|
END_TIME=$$(date +%s); \
|
|
ELAPSED_TIME=$$((END_TIME - START_TIME)); \
|
|
echo "$${NB_NAME}: $${ELAPSED_TIME}s" >> logs/timing.log; \
|
|
exit $$RET_CODE' || exit 1; \
|
|
END_TOTAL=$$(date +%s); \
|
|
TOTAL_ELAPSED=$$((END_TOTAL - START_TOTAL)); \
|
|
echo "---------------------------------" >> logs/timing.log; \
|
|
echo "Total execution time: $${TOTAL_ELAPSED}s" >> logs/timing.log; \
|
|
echo "All Notebook execution timings:" && cat logs/timing.log
|
|
|
|
# Serve documentation with auto-build and live reload
|
|
serve:
|
|
@echo "Starting auto-build server at http://localhost:$(PORT)"
|
|
@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)/html" \
|
|
--port $(PORT) \
|
|
--watch $(SOURCEDIR) \
|
|
--re-ignore ".*\.(ipynb_checkpoints|pyc|pyo|pyd|git)"
|
|
|
|
.PHONY: help Makefile compile clean serve
|
|
|
|
%: Makefile
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
clean:
|
|
find . -name "*.ipynb" -exec nbstripout {} \;
|
|
rm -rf $(BUILDDIR)
|
|
rm -rf logs
|