mkdocs.yml

# REMINDER: USE SPACES INSTEAD OF TABS IN THIS FILE

# Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: DUNE DAQ Software Documentation Home
site_description: The Official Documentation for DUNE DAQ Software Users

# Copyright
copyright: Copyright &copy; 2016 - 2021 Martin Donath

theme:
  name: material
  custom_dir: overrides
  font: false

  language: en

  features:
    - content.tabs.link
    # - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/eye
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/eye-outline
        name: Switch to light mode

extra_javascript:
  - javascripts/base.js
  - javascripts/bootstrap.min.js
  - javascripts/jquery-1.10.2.min.js

# Plugins
plugins:
  - search

# Customization
extra:
  generator: false
  version:
    provider: mike

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DUNE-DAQ

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid-experimental
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
    - Table of Contents: 
       - Overview:
          - README.md
       - Release Notes:
          - release_notes.md
       - Toolset:
          - daq-assettools:
             - About daq-assettools: packages/daq-assettools/README.md
          - daq-buildtools:
             - About daq-buildtools: packages/daq-buildtools/README.md
          - daq-cmake:
             - About daq-cmake: packages/daq-cmake/README.md
          - daq-release:
             - About daq-release: packages/daq-release/README.md
             - packages/daq-release/Build-new-external-software-stack.md
             - packages/daq-release/Build-packages-with-spack-in-a-work-area.md
             - packages/daq-release/change_tracking_process.md
             - packages/daq-release/ci_github_action.md
             - packages/daq-release/create_release_spack.md
             - packages/daq-release/creating_a_new_environment.md
             - packages/daq-release/development_workflow_gitflow.md
             - packages/daq-release/doxygen_mainpage.md
             - packages/daq-release/publish_to_cvmfs.md
             - packages/daq-release/repo_managers.md
             - packages/daq-release/team_repos.md
          - daqpytools:
             - packages/daqpytools/environment-configs.md
             - packages/daqpytools/explanation.md
             - packages/daqpytools/how-to/add-handlers-at-runtime.md
             - packages/daqpytools/how-to/best-practices.md
             - packages/daqpytools/how-to/configure-ers.md
             - packages/daqpytools/how-to/route-messages.md
             - packages/daqpytools/how-to/upgrade-package.md
             - packages/daqpytools/how-to/use-handlers.md
             - packages/daqpytools/index.md
             - packages/daqpytools/reference/troubleshooting.md
             - packages/daqpytools/severitylevels.md
             - packages/daqpytools/tutorial.md
          - daqsystemtest:
             - About daqsystemtest: packages/daqsystemtest/README.md
             - packages/daqsystemtest/bundle_script_overview.md
             - packages/daqsystemtest/integtest/README.md
          - integrationtest:
             - About integrationtest: packages/integrationtest/README.md
             - packages/integrationtest/DataFileCheckParameters.md
             - packages/integrationtest/InformationAboutSpecialVariables.md
             - packages/integrationtest/SurveyOfTriggersUsedInIntegtestsSummer2026.md
          - styleguide:
             - About styleguide: packages/styleguide/README.md
       - Core:   
          - appfwk:
             - About appfwk: packages/appfwk/README.md
             - packages/appfwk/ActionPlans.md
             - packages/appfwk/Daq-Application.md
          - cmdlib:
             - About cmdlib: packages/cmdlib/README.md
             - packages/cmdlib/Home.md
             - packages/cmdlib/User-Guide.md
          - ers:
             - About ers: packages/ers/README.md
          - logging:
             - About logging: packages/logging/README.md
             - packages/logging/ers-conventions.md
          - utilities:
             - About utilities: packages/utilities/README.md
             - packages/utilities/WorkerThread-Usage-Notes.md
       - Readout:
          - asiolibs:
             - About asiolibs: packages/asiolibs/README.md
          - cibmodules:
             - About cibmodules: packages/cibmodules/README.md
          - ctbmodules:
             - About ctbmodules: packages/ctbmodules/README.md
          - daqdataformats:
             - About daqdataformats: packages/daqdataformats/README.md
             - packages/daqdataformats/ComponentRequestV0.md
             - packages/daqdataformats/ComponentRequestV1.md
             - packages/daqdataformats/ComponentRequestV2.md
             - packages/daqdataformats/DataFormatNotes.md
             - packages/daqdataformats/FragmentHeaderV1.md
             - packages/daqdataformats/FragmentHeaderV2.md
             - packages/daqdataformats/FragmentHeaderV3.md
             - packages/daqdataformats/FragmentHeaderV4.md
             - packages/daqdataformats/FragmentHeaderV5.md
             - packages/daqdataformats/FragmentHeaderV6.md
             - packages/daqdataformats/GeoIDV0.md
             - packages/daqdataformats/GeoIDV1.md
             - packages/daqdataformats/SourceIDV2.md
             - packages/daqdataformats/TriggerRecordHeaderDataV1.md
             - packages/daqdataformats/TriggerRecordHeaderDataV2.md
             - packages/daqdataformats/TriggerRecordHeaderDataV3.md
             - packages/daqdataformats/TriggerRecordHeaderDataV4.md
             - packages/daqdataformats/TriggerRecordHeaderDataV5.md
          - datahandlinglibs:
             - About datahandlinglibs: packages/datahandlinglibs/README.md
             - packages/datahandlinglibs/Directory-structure.md
             - packages/datahandlinglibs/scripts/README.md
          - detchannelmaps:
             - About detchannelmaps: packages/detchannelmaps/README.md
             - packages/detchannelmaps/channel-maps-table.md
          - detdataformats:
             - About detdataformats: packages/detdataformats/README.md
          - dpdklibs:
             - About dpdklibs: packages/dpdklibs/README.md
             - packages/dpdklibs/utils/intel/README.md
             - packages/dpdklibs/utils/mlx/READOUT.md
          - fddetdataformats:
             - About fddetdataformats: packages/fddetdataformats/README.md
          - fdreadoutlibs:
             - About fdreadoutlibs: packages/fdreadoutlibs/README.md
             - packages/fdreadoutlibs/test/apps/README.md
          - fdreadoutmodules:
             - About fdreadoutmodules: packages/fdreadoutmodules/README.md
          - flxlibs:
             - About flxlibs: packages/flxlibs/README.md
             - packages/flxlibs/Basic-tests.md
             - packages/flxlibs/Configuring-the-EMU.md
             - packages/flxlibs/Enabling-links-and-setting-the-superchunk-factor.md
             - packages/flxlibs/FELIX-assets.md
             - packages/flxlibs/Initial-setup-of-FELIX.md
             - packages/flxlibs/Integration-tests.md
             - packages/flxlibs/Local-driver.md
          - hermesmodules:
             - About hermesmodules: packages/hermesmodules/README.md
          - lbrulibs:
             - About lbrulibs: packages/lbrulibs/README.md
             - packages/lbrulibs/integtest/README.md
             - packages/lbrulibs/socket-implementation.md
          - nddetdataformats:
             - About nddetdataformats: packages/nddetdataformats/README.md
          - snbmodules:
             - About snbmodules: packages/snbmodules/README.md
             - packages/snbmodules/Configuration.md
             - packages/snbmodules/Installation.md
             - packages/snbmodules/integtest/README.md
             - packages/snbmodules/TechnicalDocumentation.md
             - packages/snbmodules/Transfer.md
             - packages/snbmodules/Transform.md
          - tdemodules:
             - About tdemodules: packages/tdemodules/README.md
             - packages/tdemodules/amc_butler.md
             - packages/tdemodules/first_time_setup_amc.md
             - packages/tdemodules/generating_configurations.md
             - packages/tdemodules/reboot_AMCs.md
          - wibmod:
             - About wibmod: packages/wibmod/README.md
             - packages/wibmod/src/WIB1/README.md
             - packages/wibmod/src/wibmod/WIB1/README.md
       - Control:
          - appmodel:
             - About appmodel: packages/appmodel/README.md
             - packages/appmodel/SmartDaqApplication.md
          - confmodel:
             - About confmodel: packages/confmodel/README.md
          - connectivityserver:
             - About connectivityserver: packages/connectivityserver/README.md
             - packages/connectivityserver/deploy/README.md
          - daqconf:
             - About daqconf: packages/daqconf/README.md
             - packages/daqconf/ConfigPlotting.md
             - packages/daqconf/Inspector.md
             - packages/daqconf/TextualDBE.md
          - dbe:
             - About dbe: packages/dbe/README.md
             - packages/dbe/dbe.md
             - packages/dbe/schemaeditor.md
          - drunc:
             - About drunc: packages/drunc/README.md
             - packages/drunc/Controller-interface.md
             - packages/drunc/Controller.md
             - packages/drunc/FAQ.md
             - packages/drunc/FSM.md
             - packages/drunc/graph/overall/classes.md
             - packages/drunc/graph/overall/packages.md
             - packages/drunc/graph/overall/README.md
             - packages/drunc/graph/README.md
             - packages/drunc/Messaging-format.md
             - packages/drunc/Process-manager-interface.md
             - packages/drunc/Process-manager.md
             - packages/drunc/Release-notes.md
             - packages/drunc/rich_error_handling_overview.md
             - packages/drunc/Running-drunc.md
             - packages/drunc/Unified-shell-reference.md
          - nanorc:
             - About nanorc: packages/nanorc/README.md
             - packages/nanorc/FAQ-k8s.md
             - packages/nanorc/FAQ.md
             - packages/nanorc/integtests/README.md
             - packages/nanorc/src/nanorc/webuidata/static/vendor/jquery-machine/README.md
             - packages/nanorc/src/nanorc/webuidata/static/vendor/jstree/demo/README.md
             - packages/nanorc/src/nanorc/webuidata/static/vendor/jstree/README.md
          - restcmd:
             - About restcmd: packages/restcmd/README.md
             - packages/restcmd/scripts/README.md
          - runconftools:
             - About runconftools: packages/runconftools/README.md
             - packages/runconftools/generator_creation.md
             - packages/runconftools/workflow.md
          - runconf-ui:
             - About runconf-ui: packages/runconf-ui/README.md
             - packages/runconf-ui/configuration.md
             - packages/runconf-ui/developer_guide.md
             - packages/runconf-ui/quick_start.md
       - Dataflow (logical):
          - dfmessages:
             - About dfmessages: packages/dfmessages/README.md
          - dfmodules:
             - About dfmodules: packages/dfmodules/README.md
             - packages/dfmodules/integtest/README.md
             - packages/dfmodules/TRB_metrics.md
          - hdf5libs:
             - About hdf5libs: packages/hdf5libs/README.md
             - packages/hdf5libs/V3FileFormatInterfaceChanges.md
          - timing:
             - About timing: packages/timing/README.md
             - packages/timing/test/Notes.md
          - timinglibs:
             - About timinglibs: packages/timinglibs/README.md
          - tpglibs:
             - About tpglibs: packages/tpglibs/README.md
             - packages/tpglibs/testapp/BinaryFormatSpecification.md
             - packages/tpglibs/TPGStateHarvester/build.md
          - trgtools:
             - About trgtools: packages/trgtools/README.md
             - packages/trgtools/convert-tplatencies.md
             - packages/trgtools/emulate-from-tpstream.md
             - packages/trgtools/plot-emulated-triggers.md
             - packages/trgtools/process-tpstream.md
             - packages/trgtools/py-trgtools.md
             - packages/trgtools/ta-dump.md
             - packages/trgtools/tc-dump.md
             - packages/trgtools/tp-dump.md
          - trigger:
             - About trigger: packages/trigger/README.md
             - packages/trigger/integtest/README.md
             - packages/trigger/python/trigger/tpreplay_application/README.md
             - packages/trigger/trigger-alg-howto.md
       - Dataflow (physical):
          - iomanager:
             - About iomanager: packages/iomanager/README.md
             - packages/iomanager/NetworkManager.md
             - packages/iomanager/Queue.md
             - packages/iomanager/Test-Applications.md
             - packages/iomanager/Using-dynamic-connection-names.md
          - ipm:
             - About ipm: packages/ipm/README.md
          - serialization:
             - About serialization: packages/serialization/README.md
       - Monitoring:
          - erskafka:
             - About erskafka: packages/erskafka/README.md
          - kafkaopmon:
             - About kafkaopmon: packages/kafkaopmon/README.md
          - opmonlib:
             - About opmonlib: packages/opmonlib/README.md
             - packages/opmonlib/Instructions-for-DAQ-module-users.md
          - rawdatautils:
             - About rawdatautils: packages/rawdatautils/README.md
       - Educational:
          - listrev:
             - About listrev: packages/listrev/README.md