driverlib/mkdocs.yml at main · kyrylo-gr/driverlib · 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
site_name: DriverLib
site_url: https://kyrylo-gr.github.io/driverlib/
repo_url: https://github.com/kyrylo-gr/driverlib/
theme:
  name: material
  logo: images/driverlib-logo-small.png
  favicon: images/favicon.ico
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.instant
    - navigation.sections
    - search.suggest
    - search.highlight
copyright: Library published by <a href="//kyrylo.gr/" target="_blank">kyrylo.gr</a> © 2024
extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_options:
              returns_type_in_property_summary: false
            inherited_members: true
            filters:
              - '!^_' # exclude all members starting with _
              # - '^__init__$' # but always include __init__ modules and methods
              - '^__new__$' # but always include __new__ methods
              - '^__getitem__$'
              - '^__setitem__$'
            show_source: true
            show_submodules: true
            show_bases: true
            show_root_heading: false
            show_root_toc_entry: false
            show_root_full_path: true
            show_object_full_path: false
            show_symbol_type_heading: false
            show_symbol_type_toc: true
            docstring_style: google
            docstring_section_style: table
            members_order: source
            show_signature: true
            show_signature_annotations: false
            separate_signature: true
            unwrap_annotated: true
            merge_init_into_class: true
      watch: driverlib/

nav:
  - Getting Started:
      - Installation: starting_guide/install
      - First steps: starting_guide/first_steps
  - Different instruments: instruments/
  - Developer Guide: develop/
  - Releases: releases/
  - About: about/

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences