mkdocs.yml 7.36 KB
Newer Older
Matias Guijarro's avatar
Matias Guijarro committed
1
2
3
site_name: Bliss documentation
repo_name: 'bliss/bliss'
repo_url: 'https://gitlab.esrf.fr/bliss/bliss'
Matias Guijarro's avatar
Matias Guijarro committed
4
use_directory_urls: false
5
nav:
6
        - Getting started:
7
                - Installation: index.md
8
                - BLISS in a nutshell: gs_presentation.md
9
                - Data structure & access: gs_data_structure.md
Matias Guijarro's avatar
Matias Guijarro committed
10
        - Configuration:
11
12
13
14
15
16
17
18
19
20
                - Beacon:
                      - Introduction: beacon.md
                      - Running Beacon: beacon_install.md
                      - YAML files: beacon_db.md
                      - Settings: beacon_settings.md
                      - Channels: beacon_channels.md
                      - Static configuration API: beacon_static_api.md
                - BLISS objects:
                      - Object instantiation: config_plugins.md
                      - Sessions: config_sessions.md
Linus Pithan's avatar
Linus Pithan committed
21
                      - Aliases: config_alias.md
22
23
24
25
26
27
28
                      - Measurement groups: config_mg.md
                - Devices configuration templates:
                      - Motor controllers:
                            - Aerotech: config_aerotech.md
                            - Elmo: config_elmo.md
                            - Galil: config_galil.md
                            - IcePAP: config_icepap.md
29
                            - MD2S, MD3: config_md2s_motors.md
30
                            - NewFocus: config_newfocus.md
31
32
33
34
                            - PI Hexapod: config_pi_hexa.md
                            - PI Piezo: config_pi_piezo.md
                            - PM600: config_pm600.md
                            - Smaract: config_smaract.md
35
36
                            - Symetrie Hexapod: config_shexapod.md
                            - Vscanner: config_vscanner.md
37
38
39
40
                      - Slits: config_slits.md
                      - Energy and Wavelength: config_enwl.md
                      - 2D detectors (Lima): config_lima.md
                      - MCA:
41
42
43
                            - General: config_mca.md
                            - Rontec: config_mca_rontec.md
                            - XIA:
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
                              - Handel: config_mca_handel.md
                      - Temperature or pressure controllers:
                            - Temperature controllers in Bliss: config_tempctrl.md
                            - Eurotherm: config_eurotherm.md
                            - Keller: config_keller.md
                            - Lakeshore: config_lakeshore.md
                            - Meerstetter: config_meerstetter.md
                            - Oxford700: config_oxford700.md
                            - Oxford800: config_oxford800.md
                            - PACE: config_pace.md
                      - P201: config_p201.md
                      - MUSST: config_musst.md
                      - Opiom: config_opiom.md
                      - PEPU: config_pepu.md
                      - TFG: config_tango_tfg.md
                      - Nano-BPM: config_nano_bpm.md
                      - Wagos: config_wago.md
                      - Transfocators: config_transfocator.md
62
                      - Actuators: config_actuator.md
63
64
                      - Undulators: config_undulator.md
                      - Transmission: config_transmission.md
65
66
                      - Electrometers:
                            - MCCE: config_mcce.md
67
68
69
70
71
72
73
74
                      - Simulation: config_simulation.md
                      - Beamviewer: config_beamviewer.md
                      - Keithley:
                            - Ammeter and Multimeter: config_keithley.md
                            - 428: config_keithley_428.md
                      - Correlators:
                            - Flex: config_correlator_flex.md
                      - VME time frame generator: config_tango_tfg.md
75
                - Deprecated: config_deprecated.md
Cyril Guilloud's avatar
Cyril Guilloud committed
76
        - BLISS shell:
77
78
                - Command line usage: shell_cmdline.md
                - Standard functions: shell_std_func.md
79
                - Customization: shell_customization.md
Linus Pithan's avatar
Linus Pithan committed
80
                - Typing helper: shell_typing_helper.md
81
                - Logging: shell_logging.md
82
83
84
        - Motion:
                - Axis: motion_axis.md
                - Encoder: motion_encoder.md
85
                - Soft Axis: motion_softaxis.md
Linus Pithan's avatar
Linus Pithan committed
86
                - Hook: motion_hook.md
87
                - Trajectories: motion_traj.md
Matias Guijarro's avatar
Matias Guijarro committed
88
        - Scanning:
89
                - Measurement groups: config_mg.md
Matias Guijarro's avatar
Matias Guijarro committed
90
                - Default scans: scan_default.md
91
                - Alignment: scan_alignment.md
Matias Guijarro's avatar
Matias Guijarro committed
92
                - Data saving: scan_saving.md
93
                - Counters on the fly: scan_ctmg.md
94
                - BLISS scan engine explained:
95
                    - Overview: scan_engine.md
96
                    - Scan: scan_engine_scan.md
97
98
99
100
                    - Acquisition chain: scan_engine_acquisition_chain.md
                    - Acquisition Master/Device: scan_engine_acquisition_master_and_devices.md
                    - Preset: scan_engine_preset.md
                    - Data node: scan_data_node.md
Matias Guijarro's avatar
Matias Guijarro committed
101
                - Continuous scans: scan_continuous.md
102
103
        - Instruments:
                - ESRF BeamViewer (EBV): using_beamviewer.md
104
                - Shutter: using_shutter.md
Matias Guijarro's avatar
Matias Guijarro committed
105
106
107
        - Online data display:
                - Scans plotting: flint_scan_plotting.md
                - Interaction with plots: flint_interaction.md
108
        - Developers corner:
109
                - 'API documentation ⁣|https://bliss.gitlab-pages.esrf.fr/bliss/api/index.html': api.md
110
                - Guidelines: dev_guidelines.md
111
                - Writing documentation: dev_documentation.md
112
                - Communication API: dev_comm.md
Cyril Guilloud's avatar
Cyril Guilloud committed
113
                - BLISS controller: dev_write_ctrl.md
114
                - Writing a motor controller: dev_write_motctrl.md
Cyril Guilloud's avatar
Cyril Guilloud committed
115
                - Writing a calculational controller: dev_write_calc_ctrl.md
116
117
                - Writing a MCA controller: dev_write_mca.md
                - Writing a temperature controller: dev_write_tempctrl.md
118
                - Logging a controller: dev_maplog_controller.md
119
                - Writing a shutter: dev_write_shutter.md
120
                - Session Instance Map: dev_instance_map.md
Cyril Guilloud's avatar
Cyril Guilloud committed
121
                - Counters: dev_ct.md
122
                - Acquisition objects: dev_acq.md
123
124
                - Tips'n'tricks: dev_tipsntricks.md
                - Dealing with energy: dev_energy.md
Cyril Guilloud's avatar
Cyril Guilloud committed
125
                - Testing: dev_testing.md
Cyril Guilloud's avatar
Doc    
Cyril Guilloud committed
126

Matias Guijarro's avatar
Matias Guijarro committed
127
128
129
theme:
        name: material
        language: en
130
        custom_dir: 'theme'
Matias Guijarro's avatar
Matias Guijarro committed
131
        palette:
132
133
                primary: white
                accent: light blue
Matias Guijarro's avatar
Matias Guijarro committed
134
135
136
        font:
                text: Roboto
                code: 'Roboto Mono'
137
        logo: 'bliss_logo_small.svg'
Matias Guijarro's avatar
Matias Guijarro committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
markdown_extensions:
        - admonition
        - codehilite
        - pymdownx.arithmatex
        - pymdownx.betterem:
            smart_enable: all
        - pymdownx.caret
        - pymdownx.critic
        - pymdownx.details
        - pymdownx.emoji:
            emoji_generator: !!python/name:pymdownx.emoji.to_svg
        - pymdownx.inlinehilite
        - pymdownx.magiclink
        - pymdownx.mark
        - pymdownx.smartsymbols
        - pymdownx.superfences
        - pymdownx.tasklist:
            custom_checkbox: true
        - pymdownx.tilde
Matias Guijarro's avatar
Matias Guijarro committed
157
158
159
160
        - smarty
        - toc:
                permalink: true
        - sane_lists
161
        - mdx_inline_graphviz
Matias Guijarro's avatar
Matias Guijarro committed
162
163
extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
Matias Guijarro's avatar
Matias Guijarro committed
164
  - redirect.js