hovercode/mkdocs.yml at main · theperrygroup/hovercode · 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
site_name: Hovercode Python SDK
site_url: https://theperrygroup.github.io/hovercode/
repo_url: https://github.com/theperrygroup/hovercode
edit_uri: edit/main/docs/

theme:
  name: material

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            heading_level: 2
            show_source: false
            show_signature_annotations: true
  - minify:
      minify_html: true

markdown_extensions:
  - admonition
  - tables
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Authentication: getting-started/authentication.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - Overview: guides/index.md
      - Examples: guides/examples.md
      - Troubleshooting: guides/troubleshooting.md
  - API:
      - Overview: api/index.md
      - Hovercodes: api/hovercodes.md
  - Reference:
      - Overview: reference/index.md
      - Data types: reference/data-types.md
      - Exceptions: reference/exceptions.md
      - Abbreviations: includes/abbreviations.md
      - Changelog: reference/changelog.md