89 lines
2.9 KiB
TOML
89 lines
2.9 KiB
TOML
[project]
|
|
site_name = "SLS cSAXS"
|
|
site_url = "https://sls-csaxs.readthedocs.io/en/latest/"
|
|
site_description = "User and developer documentation for the cSAXS beamline"
|
|
site_author = "Paul Scherrer Institute"
|
|
repo_url = "https://gitea.psi.ch/bec/csaxs_bec"
|
|
repo_name = "bec/csaxs_bec"
|
|
copyright = "Copyright © Paul Scherrer Institute"
|
|
docs_dir = "docs"
|
|
site_dir = "site"
|
|
extra_css = ["stylesheets/extra.css"]
|
|
# Preserve Sphinx's existing page URLs.
|
|
use_directory_urls = false
|
|
exclude_docs = """
|
|
/plans/
|
|
/_build/
|
|
/api_reference/
|
|
*.log
|
|
/objects.inv
|
|
/developer/ptouch_label_printer_plan.md
|
|
"""
|
|
nav = [
|
|
{ "Home" = "index.md" },
|
|
{ "Introduction" = "introduction/introduction.md" },
|
|
{ "Safety" = "safety/safety.md" },
|
|
{ "User guide" = [
|
|
{ "Overview" = "user/user.md" },
|
|
{ "Before you arrive" = "user/before_you_arrive/before_you_arrive.md" },
|
|
{ "Ptychography" = [
|
|
{ "Overview" = "user/ptychography/ptychography.md" },
|
|
{ "flOMNI" = "user/ptychography/flomni.md" },
|
|
{ "LamNI" = "user/ptychography/lamni.md" },
|
|
{ "OMNY" = "user/ptychography/omny.md" },
|
|
{ "Ptychoshelves" = "user/ptychography/reconstructions.md" },
|
|
] },
|
|
{ "SAXS" = [
|
|
{ "Overview" = "user/saxs/saxs.md" },
|
|
{ "Online integration" = "user/saxs/online_integration.md" },
|
|
] },
|
|
{ "Data analysis" = [
|
|
{ "Overview" = "user/data_analysis/data_analysis.md" },
|
|
{ "Computing" = "user/data_analysis/computing.md" },
|
|
] },
|
|
] },
|
|
{ "Developer guide" = [
|
|
{ "Overview" = "developer/developer.md" },
|
|
{ "Editing the documentation" = "developer/editing_docs.md" },
|
|
{ "LamNI smear aid architecture" = "developer/lamni_smear_architecture.md" },
|
|
{ "PandaBox free-running setup" = "developer/panda_box_free_running_setup.md" },
|
|
{ "PandaBox data schema" = "developer/panda_box_free_running_data_schema.md" },
|
|
] },
|
|
]
|
|
|
|
[project.theme]
|
|
language = "en"
|
|
features = ["navigation.tabs", "navigation.sections", "navigation.top", "content.code.copy", "search.highlight"]
|
|
|
|
[[project.theme.palette]]
|
|
media = "(prefers-color-scheme)"
|
|
toggle.icon = "lucide/sun-moon"
|
|
toggle.name = "Switch to light mode"
|
|
|
|
[[project.theme.palette]]
|
|
media = "(prefers-color-scheme: light)"
|
|
scheme = "default"
|
|
toggle.icon = "lucide/sun"
|
|
toggle.name = "Switch to dark mode"
|
|
|
|
[[project.theme.palette]]
|
|
media = "(prefers-color-scheme: dark)"
|
|
scheme = "slate"
|
|
toggle.icon = "lucide/moon"
|
|
toggle.name = "Switch to system preference"
|
|
|
|
[project.markdown_extensions.admonition]
|
|
[project.markdown_extensions.attr_list]
|
|
[project.markdown_extensions.md_in_html]
|
|
[project.markdown_extensions.pymdownx.betterem]
|
|
smart_enable = "all"
|
|
[project.markdown_extensions.pymdownx.highlight]
|
|
[project.markdown_extensions.pymdownx.keys]
|
|
[project.markdown_extensions.pymdownx.superfences]
|
|
[project.markdown_extensions.pymdownx.tabbed]
|
|
alternate_style = true
|
|
[project.markdown_extensions.pymdownx.tasklist]
|
|
custom_checkbox = true
|
|
[project.markdown_extensions.toc]
|
|
permalink = true
|