trace/mkdocs.yml at main · slaclab/trace · 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
119
120
121
122
123
124
125
126
127
# Project Information
site_name: Trace
site_url: https://slaclab.github.io/trace/
site_author: SLAC National Accelerator Laboratory - EED / Software Applications Group
site_description: Trace is a Python application for plotting live and archived EPICS data.

# Repository
repo_name: slaclab/trace
repo_url: https://github.com/slaclab/trace

# Configuration
theme:
  name: material
  favicon: images/sqwave-blwh.svg
  logo: images/sqwave-blwh.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.top
    - navigation.tabs
    - navigation.indexes
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [trace]
          options:
            docstring_style: numpy
            members_order: source
            show_root_toc_entry: false
            show_symbol_type_toc: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
  - git-revision-date-localized:
      exclude:
        - index.md
      enable_creation_date: true
      fallback_to_build_date: true
  - git-committers:
      exclude:
        - index.md
      repository: slaclab/trace
      branch: main

# Additional Configuration
extra:
  generator: false

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - images/
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.blocks.caption

# Page Tree
nav:
  - Home: index.md
  - Getting Started:
    - installation.md
    - Input Arguments: arguments.md
    - Interface Overview:
      - overview.md
      - Plot Section: overview/plot_section.md
      - Configuration Section: overview/config_section.md
      - Footer: overview/footer.md
    - Traces: traces.md
    - Y-Axes: y_axes.md
    - Plot Config: plot_config.md
    - Import/Export: io.md
    - Tools:
      - File Converter: tools/file_converter.md
      - Archive Search: tools/search.md
      - Formula Maker: tools/formula_maker.md
      - Data Insight: tools/data_insight.md
      - E-Log Entry: tools/elog_entry.md
  - Developer Reference:
    - reference/index.md
    - reference/trace.md
    - Widgets:
      - Control Panel: reference/widgets/control_panel.md
      - Settings Popups: reference/widgets/settings_popups.md
      - Formula Dialog: reference/widgets/formula_dialog.md
      - Archive Search: reference/widgets/archive_search.md
      - Data Insight Tool: reference/widgets/data_insight_tool.md
      - E-Log Post Modal: reference/widgets/elog_post_modal.md
      - Helper Widgets: reference/widgets/helper_widgets.md
    - File IO:
      - File Converter: reference/file_io/trace_file_convert.md
      - File Handler: reference/file_io/file_handler.md
    - Services:
      - E-Log Service: reference/services/elog_client.md
      - Theme Manager: reference/services/theme_manager.md
    - Utilities:
      - Formula Validation: reference/utilities/formula_validation.md
      - Time Parser: reference/utilities/time_parser.md