opennms-api-wrapper/mkdocs.yml at main · cnewkirk/opennms-api-wrapper · 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
site_name: opennms-api-wrapper
site_description: A thin Python wrapper for the OpenNMS REST API (Horizon 35+)
site_url: https://cnewkirk.github.io/opennms-api-wrapper/
repo_url: https://github.com/cnewkirk/opennms-api-wrapper
repo_name: cnewkirk/opennms-api-wrapper

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            inherited_members: true
            filters: ["!^_"]
            members_order: alphabetical
            show_source: false
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true

nav:
  - Home: index.md
  - API Reference: api.md