Files
Jungfraujoch/make_doc.sh
T
leonarski_fandClaude Opus 4.8 cee4739221
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Failing after 3m32s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Failing after 3m35s
Build Packages / build:rpm (rocky9_nocuda) (push) Failing after 3m51s
Build Packages / build:rpm (rocky9_sls9) (push) Failing after 3m56s
Build Packages / build:rpm (rocky9) (push) Failing after 4m3s
Build Packages / build:rpm (ubuntu2204) (push) Failing after 4m13s
Build Packages / build:rpm (ubuntu2404) (push) Failing after 4m13s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 9m7s
Build Packages / Generate python client (push) Successful in 22s
Build Packages / build:rpm (rocky8) (push) Successful in 9m34s
Build Packages / Create release (push) Skipped
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 9m48s
Build Packages / Build documentation (push) Successful in 49s
Build Packages / XDS test (neggia plugin) (push) Successful in 5m56s
Build Packages / XDS test (durin plugin) (push) Successful in 6m26s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 6m36s
Build Packages / DIALS test (push) Successful in 11m8s
Build Packages / Unit tests (push) Successful in 55m19s
frontend: bundle Sphinx docs locally instead of linking readthedocs
The Documentation tab pointed at jungfraujoch.readthedocs.io, which lags
behind the installed version. Build the Sphinx docs into frontend/dist/docs
and serve them at /frontend/docs so they always match the package.

- make_doc.sh: accept an output dir (default public), absolutize it, run
  from the script dir, and allow $PYTHON override
- package.json: add "docs" script building into dist/docs
- CMakeLists: run "npm run docs" in the frontend target so CPack packs the
  docs via the existing dist/ install
- App.tsx: point the Documentation DocFrame at /frontend/docs/index.html

Also clean up the Sphinx build (911 -> 0 warnings):
- fix typo myst_heading_anchor -> myst_heading_anchors so cross-doc
  #anchor links actually resolve
- suppress myst.header/myst.xref_missing (auto-generated OpenAPI client
  docs only) and the harmless sphinx_material config.cache note
- drop a dangling "---" transition at the end of CPU_DATA_ANALYSIS.md
- add REPOSITORIES and the generated python_client model pages to toctrees

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-19 12:44:00 +02:00

32 lines
848 B
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 (default: python3.11).
OUT="${1:-public}"
PYTHON="${PYTHON:-python3.11}"
# 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/