Elke Zimoch
8f037a78c9
All checks were successful
Build and Publish Site / docker (push) Successful in 2s
174 lines
6.0 KiB
TOML
174 lines
6.0 KiB
TOML
# ============================================================================
|
|
#
|
|
# This configuration was copied from the linux/documentation repository
|
|
#
|
|
# ============================================================================
|
|
|
|
[project]
|
|
|
|
repo_url = "https://gitea.psi.ch/epics_training/epics_training_webpages"
|
|
edit_uri = "_edit/main/docs/"
|
|
|
|
# The site_name is shown in the page header and the browser window title
|
|
site_name = "EPICS Training at PSI"
|
|
|
|
# The site_description is included in the HTML head and should contain a
|
|
# meaningful description of the site content for use by search engines.
|
|
site_description = """
|
|
This is the collection of all EPICS Training webpages at PSI provided by the section Controls in AEK.
|
|
"""
|
|
|
|
site_author = "Paul Scherrer Institute"
|
|
|
|
site_url = "https://epics_training.pages.psi.ch/epics_training_webpages/"
|
|
|
|
# The copyright notice appears in the page footer and can contain an HTML
|
|
# fragment.
|
|
copyright = """
|
|
Copyright © 2026 Paul Scherrer Institute
|
|
"""
|
|
|
|
|
|
# Zensical supports both implicit navigation and explicitly defined navigation.
|
|
# If you decide not to define a navigation here then Zensical will simply
|
|
# derive the navigation structure from the directory structure of your
|
|
# docs_dir. The definition below demonstrates how a navigation structure
|
|
# can be defined using TOML syntax.
|
|
# { "Official EPICS documentation" = "https://docs.epics-controls.org/en/latest/"}
|
|
#
|
|
# Read more: https://zensical.org/docs/setup/navigation/
|
|
nav = [
|
|
{ "Home" = [
|
|
"index.md",
|
|
"anouncements.md"
|
|
]},
|
|
{ "Tutorials" = [
|
|
"tutorials/index.md",
|
|
{ "Cooler Simulation" = "tutorials/cooler_simulation.md"}
|
|
]},
|
|
{ "Recipes and Guides" = [
|
|
"stepbystep/index.md"
|
|
]},
|
|
{ "References" = [
|
|
"reference/index.md",
|
|
{ "Record Reference" = "https://docs.epics-controls.org/projects/base/en/latest/ComponentReference.html"},
|
|
{ "caQtDM" = "https://caqtdm.github.io/documentation.html"}
|
|
]},
|
|
{ "Explanations" = [
|
|
"explanation/index.md"
|
|
]},
|
|
]
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# Section for configuring theme options
|
|
# ----------------------------------------------------------------------------
|
|
[project.theme]
|
|
|
|
language = "en"
|
|
|
|
|
|
# Zensical provides a number of feature toggles that change the behavior
|
|
# of the documentation site.
|
|
features = [
|
|
# Zensical includes an announcement bar. This feature allows users to
|
|
# dismiss it when they have read the announcement.
|
|
"announce.dismiss",
|
|
|
|
# If you have a repository configured and turn feature this on, Zensical
|
|
# will generate an edit button for the page. This works for common
|
|
# repository hosting services.
|
|
# "content.action.edit",
|
|
|
|
# Code annotations allow you to add an icon with a tooltip to your
|
|
# code blocks to provide explanations at crucial points.
|
|
"content.code.annotate",
|
|
|
|
# This feature turns on a button in code blocks that allow users to
|
|
# copy the content to their clipboard without first selecting it.
|
|
"content.code.copy",
|
|
|
|
|
|
# Code blocks can include a button to allow for the selection of line
|
|
# ranges by the user.
|
|
"content.code.select",
|
|
|
|
# Zensical can render footnotes as inline tooltips, so the user can read
|
|
# the footnote without leaving the context of the document.
|
|
"content.footnote.tooltips",
|
|
|
|
# If you have many content tabs that have the same titles (e.g., "Python",
|
|
# "JavaScript", "Cobol"), this feature causes all of them to switch to
|
|
# at the same time when the user chooses their language in one.
|
|
"content.tabs.link",
|
|
|
|
# When tabs are enabled, top-level sections are rendered in a menu layer
|
|
# below the header
|
|
# When sticky tabs are enabled, navigation tabs will lock below the header
|
|
# and always remain visible when scrolling down.
|
|
"navigation.tabs",
|
|
"navigation.tabs.sticky",
|
|
|
|
"content.tooltips",
|
|
|
|
# This feature turns on navigation elements in the footer that allow the
|
|
# user to navigate to a next or previous page.
|
|
# "navigation.footer",
|
|
|
|
# When section index pages are enabled, documents can be directly attached
|
|
# to sections, which is particularly useful for providing overview pages.
|
|
"navigation.indexes",
|
|
|
|
# When instant navigation is enabled, clicks on all internal links will be
|
|
# intercepted and dispatched via XHR without fully reloading the page.
|
|
"navigation.instant",
|
|
|
|
# With instant prefetching, your site will start to fetch a page once the
|
|
# user hovers over a link. This will reduce the perceived loading time
|
|
# for the user.
|
|
"navigation.instant.prefetch",
|
|
|
|
# When navigation paths are activated, a breadcrumb navigation is rendered
|
|
# above the title of each page
|
|
"navigation.path",
|
|
|
|
# When search highlighting is enabled and a user clicks on a search result,
|
|
# Zensical will highlight all occurrences after following the link.
|
|
"search.highlight",
|
|
|
|
# A back-to-top button can be shown when the user, after scrolling down,
|
|
# starts to scroll up again.
|
|
"navigation.top",
|
|
|
|
|
|
# When anchor tracking is enabled, the URL in the address bar is
|
|
# automatically updated with the active anchor as highlighted in the table
|
|
# of contents.
|
|
"navigation.tracking",
|
|
]
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# In the "palette" subsection you can configure options for the color scheme.
|
|
# You can configure different color # schemes, e.g., to turn on dark mode,
|
|
# that the user can switch between. Each color scheme can be further
|
|
# customized.
|
|
# Read more:
|
|
# - https://zensical.org/docs/setup/colors/
|
|
# ----------------------------------------------------------------------------
|
|
|
|
[[project.theme.palette]]
|
|
scheme = "default"
|
|
toggle.icon = "lucide/sun"
|
|
toggle.name = "Switch to dark mode"
|
|
|
|
[[project.theme.palette]]
|
|
scheme = "slate"
|
|
toggle.icon = "lucide/moon"
|
|
toggle.name = "Switch to light mode"
|
|
|
|
[project.theme.icon]
|
|
#logo = "simple/gitea"
|
|
logo = "lucide/rocking-chair"
|
|
repo = "simple/gitea"
|