openPMD-beamphysics/mkdocs.yml at master · electronsandstuff/openPMD-beamphysics · 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
site_name: openPMD-beamphysics
repo_url: https://github.com/ChristopherMayes/openPMD-beamphysics
repo_name: ChristopherMayes/openPMD-beamphysics

nav:
  - Home: index.md

  - Examples:
      - Particles:
          - examples/particle_examples.ipynb
          - examples/normalized_coordinates.ipynb
          - examples/read_examples.ipynb
          - examples/write_examples.ipynb
          - examples/plot_examples.ipynb
          - examples/bunching.ipynb
      - Fields:
          - examples/fields/field_examples.ipynb
          - examples/fields/field_expansion.ipynb
          - examples/fields/field_tracking.ipynb
          - examples/fields/field_conversion.ipynb
          - examples/fields/corrector_modeling.ipynb
          - examples/fields/solenoid_modeling.ipynb
      - Wavefront:
          - examples/wavefront/wavefront.ipynb
          - examples/wavefront/advanced_drift.ipynb
          - examples/wavefront/experimental_pytorch_wavefront.ipynb
      - Utilities:
          - examples/units.ipynb
          - examples/labels.ipynb

  - API:
      - Particles: api/particles.md
      - Fields: api/fields.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
  - pymdownx.arithmatex: # Enable MathJAX https://squidfunk.github.io/mkdocs-material/reference/mathjax/
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ChristopherMayes/openPMD-beamphysics
      name: openPMD-beamphysics

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
              - https://docs.h5py.org/en/stable/objects.inv