mmg_toolbox/mkdocs.yml at main · DiamondLightSource/mmg_toolbox · 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
130
131
132
133
134
135
136
site_name: MMG_Toolbox
site_url: https://diamondlightsource.github.io/mmg_toolbox/
repo_name: mmg_toolbox
repo_url: https://github.com/DiamondLightSource/mmg_toolbox

theme:
  name: material

plugins:
  - techdocs-diamond
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

nav:
  - Home:
    - index.md
  - Installation:
    - installation/index.md
  - Examples:
    - examples/index.md
    - examples/examples.md
    - examples/peak_fitting.md
    - examples/xas_and_xmcd.md
  - Code Description:
    - description/index.md
    - beamline_metadata:
      - description\beamline_metadata_config.md
      - description\beamline_metadata_hdfmap_generic.md
      - description\beamline_metadata_metadata_strings.md
    - diffraction:
      - description\diffraction_diffcalc.md
      - description\diffraction_lattice.md
      - description\diffraction_msmapper.md
    - fitting:
      - description\fitting_fit_functions.md
      - description\fitting_functions.md
      - description\fitting_manager.md
      - description\fitting_models.md
      - description\fitting_results.md
    - nexus:
      - description\nexus_instrument_model.md
      - description\nexus_nexus_functions.md
      - description\nexus_nexus_names.md
      - description\nexus_nexus_reader.md
      - description\nexus_nexus_scan.md
      - description\nexus_nexus_transformations.md
      - description\nexus_nexus_writer.md
    - plotting:
      - description\plotting_exp_plot_manager.md
      - description\plotting_matplotlib.md
      - description\plotting_scan_plot_manager.md
    - tkguis:
      - apps:
        - description\tkguis_apps_config_editor.md
        - description\tkguis_apps_data_viewer.md
        - description\tkguis_apps_edit_text.md
        - description\tkguis_apps_experiment.md
        - description\tkguis_apps_file_browser.md
        - description\tkguis_apps_log_viewer.md
        - description\tkguis_apps_multi_scan_analysis.md
        - description\tkguis_apps_namespace_select.md
        - description\tkguis_apps_nexus.md
        - description\tkguis_apps_peak_fit_analysis.md
        - description\tkguis_apps_python_editor.md
        - description\tkguis_apps_scans.md
        - description\tkguis_apps_script_runner.md
        - description\tkguis_apps_visit_viewer.md
      - description\tkguis_cli.md
      - description\tkguis_experiment_management.md
      - misc:
        - description\tkguis_misc_beamline_metadata.md
        - description\tkguis_misc_config.md
        - description\tkguis_misc_functions.md
        - description\tkguis_misc_jupyter.md
        - description\tkguis_misc_logging.md
        - description\tkguis_misc_matplotlib.md
        - description\tkguis_misc_processing_options.md
        - description\tkguis_misc_screen_size.md
        - description\tkguis_misc_search.md
        - description\tkguis_misc_styles.md
      - widgets:
        - description\tkguis_widgets_find_scans.md
        - description\tkguis_widgets_folder_treeview.md
        - description\tkguis_widgets_hdf_viewer.md
        - description\tkguis_widgets_image_slider.md
        - description\tkguis_widgets_instrument_visits.md
        - description\tkguis_widgets_log_viewer.md
        - description\tkguis_widgets_multi_scan_analysis.md
        - description\tkguis_widgets_nexus_data_viewer.md
        - description\tkguis_widgets_nexus_details.md
        - description\tkguis_widgets_nexus_image.md
        - description\tkguis_widgets_nexus_plot.md
        - description\tkguis_widgets_nexus_plot_and_image.md
        - description\tkguis_widgets_nexus_string_views.md
        - description\tkguis_widgets_nexus_treeview.md
        - description\tkguis_widgets_peak_fit_analysis.md
        - description\tkguis_widgets_python_editor.md
        - description\tkguis_widgets_roi_editor.md
        - description\tkguis_widgets_scan_range_selector.md
        - description\tkguis_widgets_scan_selector.md
        - description\tkguis_widgets_script_runner.md
        - description\tkguis_widgets_simple_plot.md
        - description\tkguis_widgets_size_tester.md
        - description\tkguis_widgets_title_window.md
        - description\tkguis_widgets_treeview.md
    - utils:
      - description\utils_dat_file_reader.md
      - description\utils_env_functions.md
      - description\utils_experiment.md
      - description\utils_file_functions.md
      - description\utils_file_reader.md
      - description\utils_gda_functions.md
      - description\utils_misc_functions.md
      - description\utils_nb_runner.md
      - description\utils_polarisation.md
      - description\utils_rotations.md
      - description\utils_units.md
      - description\utils_xray_utils.md
    - xas:
      - description\xas_nxxas_loader.md
      - description\xas_spectra.md
      - description\xas_spectra_analysis.md
      - description\xas_spectra_container.md