pybes3/mkdocs.yml at main · mrzimu/pybes3 · 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
site_name: Documentation for pybes3
repo_url: https://github.com/mrzimu/pybes3
site_author: Mingrun Li

theme:
  name: material
  features:
    - toc
    - search
    - search.suggest
    - footer
    - content.code.copy
    - content.tabs.link
    - navigation.top
    - navigation.sections

  palette:
    # Palette toggle for automatic mode
    - media: (prefers-color-scheme)
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.betterem
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_signature: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            heading_level: 3
            separate_signature: false

nav:
  - Home: index.md
  - Installation: installation.md
  - Convention:
      - Unit: convention/unit.md
      - Global ID (gid): convention/global-id.md
  - User manual:
      - BES3 data reading: user-manual/bes3-data-reading.md
      - Digi identifier: user-manual/digi-identifier.md
      - Detector: user-manual/detector.md
      - Helix operations: user-manual/helix.md
  - API Reference:
      - pybes3: api/pybes3.md
      - pybes3.besio: api/pybes3.besio.md
      - pybes3.digi_id: api/pybes3.digi_id.md
      - pybes3.detectors: api/pybes3.detectors.md
      - pybes3.helix: api/pybes3.helix.md