python/mkdocs.yml at main · harp-tech/python · 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
site_name: harp
site_url: https://harp-tech.org/python/
repo_url: https://github.com/harp-tech/python
repo_name: "harp-tech/python"
copyright: Copyright (c) harp-tech and Contributors

exclude_docs: |
  includes/

plugins:
  - search
  - autorefs
  - codeinclude
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_heading: true
            show_submodules: true
            show_source: false
            extensions:
              - griffe_fieldz
  - git-authors


markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - toc:
      permalink: "#"

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  logo: assets/logo.svg
  favicon: assets/favicon.png
  features:
    - content.tooltips
    - toc.follow
    - content.code.copy
    - navigation.sections
    - navigation.indexes
    - navigation.footer
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: light-blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: light-blue
      toggle:
        icon: material/weather-night
        name: Switch to system preference

nav:
  - Introduction: index.md
  - Examples:
    - Read device info: examples/device-info.md
    - Read and write registers: examples/read-write-registers.md
    - Subscribe to events: examples/events.md
    - Read a dataset folder: examples/dataset.md
    - Read a single register file: examples/register-file.md
    - Registers from a schema: examples/registers-from-schema.md
  - Guides:
    - Choose a device module: articles/device-modules.md
    - Migrate from harp-python: articles/harp-python-migration.md
  - API:
    - Protocol: api/protocol.md
    - Serial: api/serial.md
    - Device: api/device.md
    - Data: api/data.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/harp-tech/python

extra_css:
- stylesheets/extra.css