radiacode/mkdocs.yml at master · cdump/radiacode · 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
site_name: RadiaCode Python Library
site_description: Python interface for RadiaCode-10x radiation detectors and spectrometers
site_url: https://cdump.github.io/radiacode/
repo_url: https://github.com/cdump/radiacode
repo_name: cdump/radiacode
edit_uri: edit/master/docs/

theme:
  name: material
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - navigation.footer
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Guides:
      - Connections: guides/connections.md
      - Measurements and units: guides/measurements.md
      - Spectra and calibration: guides/spectra.md
      - Device configuration: guides/configuration.md
      - Included examples: guides/examples.md
  - API reference:
      - Overview: reference/index.md
      - Device: reference/device.md
      - Data records: reference/data.md
      - Enums: reference/enums.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            filters: ["!^_"]
            heading_level: 2
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            show_root_full_path: false
            show_root_heading: true
            show_signature_annotations: true
            show_source: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

copyright: Copyright &copy; Maxim Andreev and contributors