signtraker/mkdocs.yml at main · theperrygroup/signtraker · 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
97
98
99
100
101
site_name: SignTraker Python Client
site_description: Typed Python client for the SignTraker API
site_author: SignTraker Python Client Contributors
repo_url: https://github.com/theperrygroup/signtraker
repo_name: theperrygroup/signtraker
edit_uri: ""

# The docs-only planning tree lives under docs/planning/ but is not part of the
# published site.
exclude_docs: |
  planning/


theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: table
            show_root_heading: true
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            merge_init_into_class: true
            filters:
              - "!^_"

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Authentication: getting-started/authentication.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - Querying & OData: guides/querying.md
      - Working with Agents: guides/agents.md
      - Orders & Services: guides/orders.md
      - Error Handling: guides/error-handling.md
  - API Reference:
      - Overview: api/index.md
      - Client: api/client.md
      - Agents: api/agents.md
      - Change Orders: api/change-orders.md
      - Credits: api/credits.md
      - Enterprises: api/enterprises.md
      - Offices: api/offices.md
      - Order Presets: api/order-presets.md
      - Orders: api/orders.md
      - Services: api/services.md
  - Reference:
      - Data Types & Enums: reference/data-types.md
      - Exceptions: reference/exceptions.md
      - Changelog: reference/changelog.md
  - Development:
      - Contributing: development/contributing.md
      - Deployment: development/deployment.md
      - Style Guide: development/style-guide.md