mkdocs.yml

site_name: phyphox docs
site_description: >-
  Technical documentation for phyphox - the experiment file format and the
  remote-interface API.
site_url: https://phyphox.org/docs/
repo_url: https://github.com/phyphox/phyphox-docs
# No edit_uri: the per-page edit buttons invited drive-by edits on GitHub, and
# with the spec-generated reference sections most of them would land in the
# wrong place anyway (the facts live in spec/, not on the page). Contributions
# go through issues and pull requests on the repository instead.
edit_uri: ""
copyright: >-
  RWTH Aachen University. "phyphox" and "RWTH Aachen University" as well as the
  RWTH Aachen logo are registered trademarks.

docs_dir: docs
site_dir: site

# A broken heading anchor is as bad as a broken link, and much easier to
# introduce when pages are split up. --strict promotes both to build errors.
validation:
  links:
    anchors: warn

theme:
  name: material
  language: en
  # overrides/partials/source.html drops the mount point Material uses to fetch
  # star counts from api.github.com on every page view. See the file for why.
  custom_dir: overrides
  # Material otherwise pulls Roboto from fonts.googleapis.com on every page,
  # which makes every visitor's browser contact Google. This site must not load
  # anything from a third party, so the system font stack is used instead.
  # Do not set this to a font name: any value here reintroduces the request.
  font: false
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
  # Two schemes, picked by the visitor's system preference and switchable from
  # the header. Both are styled - check both after any color change.
  #
  # `deep orange` is a placeholder: this Material version accepts only its own
  # palette names here, and docs/assets/stylesheets/phyphox.css overrides every
  # color it sets with the app's #ff7e22. Renaming it changes nothing visible.
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

hooks:
  - tools/hooks.py

markdown_extensions:
  - admonition
  - def_list
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys

# Overrides the theme's palette with the app's own colors. Loaded after the
# theme's stylesheets, which is what lets it win.
extra_css:
  - assets/stylesheets/phyphox.css

plugins:
  - search
  - awesome-nav
  # Renders <swagger-ui src="..."/> tags. The plugin vendors Swagger UI itself,
  # so the built site stays self-contained - no CDN at page load.
  - swagger-ui-tag:
      background: transparent
      docExpansion: list
      syntaxHighlightTheme: monokai
      # No "Try it out" buttons. They would send an http:// request to the
      # phone, and the site is served over https, so the browser blocks every
      # one of them as mixed content before it leaves the page - the button
      # just spins. An empty list is what removes the button; tryItOutEnabled
      # only controls whether the panel starts open. See the warning on
      # docs/remote-interface/api-reference.md.
      supportedSubmitMethods: []
      # Corrects the vendored Swagger UI's inline-code spacing inside the
      # iframe; see the file for what it fixes and why it cannot live in
      # phyphox.css, which only reaches the surrounding docs page.
      extra_css:
        - assets/stylesheets/swagger-ui-overrides.css