mkdocs.yml

site_name: LUTE
repo_url: https://github.com/slac-lcls/lute
site_author: GFD, VM
copyright: © 2024 LCLS
nav:
  - Quick Start: "quick_start.md"
  - Usage Manual:
      - Task Configuration: "usage/configuration.md"
      - Running LUTE: "usage/running_lute.md"
  - Developer Documentation:
      - Creating a new Task: "development/new_task.md"
      - Creating a new Workflow: "development/creating_workflows.md"
  - Source Code:
      - managed_tasks: "source/managed_tasks.md"
      - execution:
          - executor: "source/execution/executor.md"
          - ipc: "source/execution/ipc.md"
          - debug_utils: "source/execution/debug_utils.md"
          - logging: "source/execution/logging.md"
      - tasks:
          - task: "source/tasks/task.md"
          - tasklets: "source/tasks/tasklets.md"
          - dataclasses: "source/tasks/dataclasses.md"
          - geometry: "source/tasks/geometry.md"
          - _geometry: "source/tasks/_geometry.md"
          - sfx_find_peaks: "source/tasks/sfx_find_peaks.md"
          - sfx_index: "source/tasks/sfx_index.md"
          - smalldata: "source/tasks/smalldata.md"
          - _smalldata: "source/tasks/_smalldata.md"
          - math: "source/tasks/math.md"
          - test: "source/tasks/test.md"
          - mpi_test: "source/tasks/mpi_test.md"
          - util:
              - html: "source/tasks/util/html.md"
      - io:
          - models:
              - base: "source/io/models/base.md"
              - geometry: "source/io/models/geometry.md"
              - sfx_find_peaks: "source/io/models/sfx_find_peaks.md"
              - sfx_index: "source/io/models/sfx_index.md"
              - sfx_merge: "source/io/models/sfx_merge.md"
              - sfx_solve: "source/io/models/sfx_solve.md"
              - smd: "source/io/models/smd.md"
              - validators: "source/io/models/validators.md"
              - tests: "source/io/models/tests.md"
              - mpi_tests: "source/io/models/mpi_tests.md"
          - config: "source/io/config.md"
          - db: "source/io/db.md"
          - _sqlite: "source/io/_sqlite.md"
          - elog: "source/io/elog.md"
          - exceptions: "source/io/exceptions.md"

  - Design and Specifications:
      - Database: "design/database.md"
plugins:
- search
#- gen-files:
#    scripts:
#    - scripts/gen_ref_pages.py
- mkdocstrings:
    enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
    default_handler: python
    handlers:
      python:
        paths: [lute]
        options:
          show_source: true
          filters:
            - "!__author__"
            - "!__all__"
- mike:
    # These fields are all optional; the defaults are as below...
    alias_type: symlink
    redirect_template: null
    deploy_prefix: ''
    canonical_version: dev
    version_selector: true
    css_dir: css
    javascript_dir: js
theme:
  #name: readthedocs
  name: material