lute/mkdocs.yml at dev · LouConreux/lute · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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"
      - Installation: "usage/installation.md"
      - Running LUTE: "usage/running_lute.md"
      - A complete simple example: "usage/hello_world.md"
      - Task Documentation:
          - Using smalldata_tools: "usage/tasks/smalldata_tools.md"
          - Converting XTC1 to XTC2: "usage/tasks/xtc1_to_xtc2_conversion.md"
          - Running BayFAI: "usage/tasks/bayfai.md"
  - Developer Documentation:
      - Architecture and Execution Model: "development/architecture.md"
      - Creating a new Task:
          - Overview: "development/new_task/overview.md"
          - First Party: "development/new_task/first_party.md"
          - Third Party: "development/new_task/third_party.md"
      - Creating a new Workflow:
          - Overview: "development/creating_workflows.md"
          - With Maestro: "development/creating_workflows_maestro.md"
          - With Airflow: "development/creating_workflows_airflow.md"
          - Dynamic Run-time Workflows: "development/dynamic_workflows.md"
          #- With Prefect: "development/creating_workflows_prefect.md"
      - Maestro Documentation: "development/maestro.md"
      - Tests: "development/tests.md"
  - Source Code:
      - managed_tasks: "source/managed_tasks.md"
      - execution:
          - debug_utils: "source/execution/debug_utils.md"
          - executor: "source/execution/executor.md"
          - ipc: "source/execution/ipc.md"
          - launch: "source/execution/launch.md"
          - logging: "source/execution/logging.md"
          - subprocess_utils: "source/execution/subprocess_utils.md"
      - tasks:
          - task: "source/tasks/task.md"
          - tasklets: "source/tasks/tasklets.md"
          - dataclasses: "source/tasks/dataclasses.md"
          - bayfai: "source/tasks/bayfai.md"
          - _bayfai: "source/tasks/_bayfai.md"
          - _bayfai2: "source/tasks/_bayfai2.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"
              - environment: "source/tasks/util/environment.md"
      - io:
          - models:
              - base: "source/io/models/base.md"
              - bayfai: "source/io/models/bayfai.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"
          - calib: "source/io/calib.md"
          - config: "source/io/config.md"
          - db: "source/io/db.md"
          - _db:
              - common_sqlite: "source/io/_db/common_sqlite.md"
              - v2:
                  - api: "source/io/_db/v2/api.md"
                  - _sqlite: "source/io/_db/v2/_sqlite.md"
              - v1:
                  - api: "source/io/_db/v1/api.md"
                  - _sqlite: "source/io/_db/v1/_sqlite.md"
          - elog: "source/io/elog.md"
          - exceptions: "source/io/exceptions.md"
          - parameters: "source/io/parameters.md"
          - version_utils: "source/io/version_utils.md"

  - Design and Specifications:
      - Database:
          - API v0.2: "design/database_v2.md"
          - API v0.1: "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