pytao/mkdocs.yml at master · bmad-sim/pytao · 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
128
129
site_name: PyTao
repo_url: https://github.com/bmad-sim/pytao
repo_name: Bmad-Sim/PyTao

nav:
  - Home: index.md

  - Installation: installation.md

  - Usage: usage.md
  - Releases: release_notes.md

  - Examples:
      - examples/basic.ipynb
      - examples/elements.ipynb
      - examples/config.ipynb
      - examples/plot-matplotlib.ipynb
      - examples/plot-bokeh.ipynb
      - examples/plot-bokeh-vars.ipynb
      - examples/plot-bokeh-particles.ipynb
      - examples/bunch.ipynb
      - examples/special_parsers.ipynb
      - examples/fodo.ipynb
      - examples/beam_track_progress_bar.ipynb

  - Constraints:
      - constraints/index.md
      - constraints/config.md
      - API:
        - constraints/api/index.md
        - constraints/api/ele.md
        - constraints/api/datum.md

  - Dev:
      - development.md

  - API:
      - Tao: api/tao.md
      - SubprocessTao: api/subprocesstao.md
      - Model Base Classes: api/model.md
      - TaoConfig: api/config.md
      - Lattice / Element: api/element.md
      - Plotting: api/plot.md
      - Matplotlib: api/plot-mpl.md
      - Bokeh: api/plot-bokeh.md

theme:
  icon:
    repo: fontawesome/brands/github
  name: material

  custom_dir: docs/overrides
  features:
    - navigation.top
    - navigation.tabs
    - navigation.indexes
  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

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bmad-sim/pytao
      name: PyTao

extra_css:
  - stylesheets/extra.css

plugins:
  - search

  - mkdocs-jupyter:
      include_source: True

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            filters:
              - "!^_" # exclude all members starting with _
              - "^__init__$" # but always include __init__ modules and methods
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: false
            heading_level: 3
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: false
            show_object_full_path: true
            show_category_heading: true
            show_if_no_docstring: false
            show_signature: true
            signature_crossrefs: true
            show_signature_annotations: false
            separate_signature: true
            line_length: 100
            merge_init_into_class: true
            show_source: true
            show_bases: true
            show_submodules: false
            group_by_category: true
            unwrap_annotated: true
            import:
              - https://docs.python.org/3/objects.inv
          rendering:
            show_source: true
            show_root_heading: true