Files
Jungfraujoch/make_doc.sh
leonarski_f 75e401f0e5
Build Packages / Unit tests (push) Successful in 1h31m59s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 8m43s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m5s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 9m27s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m56s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 9m24s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 10m27s
Build Packages / build:rpm (rocky8) (push) Successful in 9m20s
Build Packages / build:rpm (rocky9) (push) Successful in 10m50s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 9m54s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 8m38s
Build Packages / DIALS test (push) Successful in 12m13s
Build Packages / XDS test (durin plugin) (push) Successful in 7m8s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 7m8s
Build Packages / XDS test (neggia plugin) (push) Successful in 7m50s
Build Packages / Generate python client (push) Successful in 16s
Build Packages / Build documentation (push) Successful in 50s
Build Packages / Create release (push) Skipped
v1.0.0-rc.153 (#63)
This is an UNSTABLE release. It includes many experimental features, as well as many AI generated fixes. We recommend using rc.152 for production use.

* jfjoch_broker: Add EXPERIMENTAL pixelrefine mode for image processing
* jfjoch_broker: Allow to load user mask from 8-bit and 16-bit TIFF files
* jfjoch_broker: Add ROI calculation in non-FPGA workflow
* jfjoch_broker: Fixes to TCP image pusher
* jfjoch_broker: Remove NUMA bindings
* jfjoch_broker: Improvements to indexing
* jfjoch_broker: For PSI EIGER, trimming energies are taken from the detector configuration (now compulsory) instead of hardcoded values
* jfjoch_writer: Save ROI definitions and the per-pixel ROI bitmap in the master file; azimuthal ROIs support phi (angular) sectors
* jfjoch_viewer: Major redesign with dockable panels and saved layouts, plus on-canvas creation/move/resize of box, circle and azimuthal ROIs
* jfjoch_viewer: Run jfjoch_process reprocessing jobs from inside the GUI and overlay per-run results

Reviewed-on: #63
2026-06-23 20:29:49 +02:00

46 lines
1.2 KiB
Bash

#!/bin/bash
set -euo pipefail
# Build the Sphinx HTML documentation.
#
# Usage: make_doc.sh [output_dir]
# output_dir where the rendered HTML is written (default: ./public).
# Relative paths are resolved against the caller's working
# directory, so the frontend build can point this at frontend/dist/docs.
#
# The Python interpreter can be overridden with $PYTHON. Otherwise the newest
# available python3.x is used (the bare "python3" is often too old).
OUT="${1:-public}"
if [ -z "${PYTHON:-}" ]; then
for candidate in python3.13 python3.12 python3.11 python3; do
if command -v "$candidate" >/dev/null 2>&1; then
PYTHON="$candidate"
break
fi
done
fi
if [ -z "${PYTHON:-}" ]; then
echo "No python3 interpreter found" >&2
exit 1
fi
echo "Using $PYTHON ($("$PYTHON" --version 2>&1))"
# Resolve the output directory to an absolute path before we change directories.
mkdir -p "$OUT"
OUT="$(cd "$OUT" && pwd)"
# Run from the repository root regardless of where the script was invoked from.
cd "$(dirname "$0")"
"$PYTHON" -m venv tmp_venv/
source tmp_venv/bin/activate
pip install -r docs/requirements.txt
sphinx-build -b html docs "$OUT"
rm -rf tmp_venv/