stocktrim-openapi-client/mkdocs.yml at main · dougborg/stocktrim-openapi-client · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: StockTrim OpenAPI Client
site_description: Python client library and MCP server for StockTrim Inventory Management API
site_author: Doug Borg
site_url: https://dougborg.github.io/stocktrim-openapi-client/
repo_url: https://github.com/dougborg/stocktrim-openapi-client
repo_name: dougborg/stocktrim-openapi-client
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - Client Usage: user-guide/client-guide.md
      - Helper Methods: user-guide/helper-methods.md
      - Error Handling: user-guide/error-handling.md
      - Testing: user-guide/testing.md
  - MCP Server:
      - Overview: mcp-server/overview.md
      - Installation: mcp-server/installation.md
      - Available Tools: mcp-server/tools.md
      - Claude Desktop Setup: mcp-server/claude-desktop.md
  - API Reference:
      - Client: api/client.md
      - Helpers: api/helpers.md
  - Architecture:
      - Overview: architecture/overview.md
      - Transport Layer: architecture/transport.md
      - Domain Helpers: architecture/helpers.md
  - Contributing:
      - Development Setup: contributing/development.md
      - Code of Conduct: contributing/code-of-conduct.md
      - API Feedback: contributing/api-feedback.md
  - Changelog: CHANGELOG.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dougborg
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/stocktrim-openapi-client/

copyright: Copyright &copy; 2024-2025 Doug Borg