Files
Jungfraujoch/docs/index.rst
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

81 lines
1.4 KiB
ReStructuredText

.. image:: jfjoch.png
:width: 256
:align: left
PSI Jungfraujoch
================
Jungfraujoch is data acquisition and on-the-fly analysis system developed by the `Paul Scherrer Institut <https://www.psi.ch>`__.
It can be currently used with PSI and DECTRIS detectors.
Jungfraujoch is distributed under the GPLv3 license.
.. toctree::
:maxdepth: 1
:caption: General
ACKNOWLEDGEMENT
LICENSE
DETECTORS
HARDWARE
SOFTWARE
VERSIONING
DEPLOYMENT
REPOSITORIES
CHANGELOG
.. toctree::
:maxdepth: 1
:caption: Software
JFJOCH_BROKER
JFJOCH_WRITER
JFJOCH_PROCESS
JFJOCH_VIEWER
SOFTWARE_INTEGRATION
TOOLS
.. toctree::
:maxdepth: 1
:caption: FPGA
FPGA
FPGA_LICENSE
FPGA_DESIGN
FPGA_NETWORK
FPGA_PCIE_DRIVER
FPGA_SETTINGS
FPGA_DATA_ANALYSIS
.. toctree::
:maxdepth: 1
:caption: Reference
DETECTOR_GEOMETRY
CPU_DATA_ANALYSIS
OPENAPI
OPENAPI_SPECS
CBOR
HDF5
IMAGE_STREAM
PIXEL_MASK
WEB_FRONTEND
TESTS
.. toctree::
:maxdepth: 1
:caption: OpenAPI Python client
python_client/README
python_client/docs/DefaultApi
.. The remaining python_client/docs/*.md pages are generated per-model reference
files linked from the client README/DefaultApi; include them in a hidden glob
toctree so they are built without each one warning about being orphaned.
.. toctree::
:hidden:
:glob:
python_client/docs/*