leonarski_f
2ab9deb20b
All checks were successful
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 11m28s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m30s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 12m4s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m24s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m19s
Build Packages / Generate python client (push) Successful in 35s
Build Packages / Build documentation (push) Successful in 15s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 11m40s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky8) (push) Successful in 9m56s
Build Packages / build:rpm (rocky9) (push) Successful in 11m15s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 10m54s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 10m3s
Build Packages / Unit tests (push) Successful in 56m9s
Documentation update Reviewed-on: #40
77 lines
2.0 KiB
Python
77 lines
2.0 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.132'
|
|
|
|
# -- 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_anchor = 3
|
|
|
|
# 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
|
|
|