leonarski_f
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
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>
85 lines
2.5 KiB
Python
85 lines
2.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'Jungfraujoch'
|
|
copyright = '2024, Paul Scherrer Institute'
|
|
author = 'Filip Leonarski'
|
|
release = '1.0.0-rc.153'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'myst_parser',
|
|
'sphinx.ext.mathjax',
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
|
|
myst_enable_extensions = [
|
|
'linkify',
|
|
'smartquotes',
|
|
'dollarmath',
|
|
'amsmath',
|
|
]
|
|
|
|
myst_heading_anchors = 3
|
|
|
|
# The OpenAPI Python-client pages under docs/python_client/ are generated by the
|
|
# openapi-generator and contain header-level jumps and intra-page anchors that MyST
|
|
# cannot resolve. We do not hand-edit generated files, so silence that noise here;
|
|
# the hand-written docs are anchor-clean once myst_heading_anchors is set above.
|
|
# 'config.cache' fires only because the sphinx_material theme stores a function in
|
|
# html_context, which is harmless for our single-shot builds.
|
|
suppress_warnings = ['myst.header', 'myst.xref_missing', 'config.cache']
|
|
|
|
# Render LaTeX-style math nicely in HTML and support AMS-style equation numbering.
|
|
mathjax3_config = {
|
|
"tex": {
|
|
"tags": "ams",
|
|
"inlineMath": [['\\(', '\\)'], ['$', '$']],
|
|
"displayMath": [['\\[', '\\]'], ['$$', '$$']],
|
|
"processEscapes": True,
|
|
}
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'sphinx_material'
|
|
html_static_path = ['../broker/redoc-static.html']
|
|
#html_theme_options = {
|
|
# 'sidebar_width': '300px',
|
|
# 'page_width': 'auto'
|
|
#}
|
|
|
|
html_theme_options = {
|
|
'repo_url': 'https://gitea.psi.ch/mx/jungfraujoch',
|
|
'repo_name': 'Jungfraujoch',
|
|
'nav_title': 'PSI Jungfraujoch',
|
|
'html_minify': True,
|
|
'css_minify': True,
|
|
'globaltoc_depth': 2,
|
|
'repo_type': 'gitlab',
|
|
'color_primary': 'indigo',
|
|
'color_accent': 'lime',
|
|
'logo_icon': ''
|
|
}
|
|
|
|
html_logo = 'jfjoch.png'
|
|
html_favicon = 'jfjoch.png'
|
|
|
|
html_sidebars = {
|
|
"**": ["logo-text.html", "globaltoc.html", "searchbox.html"]
|
|
}
|
|
|
|
|
|
html_show_sourcelink = False
|
|
|