bloomy-python/mkdocs.yml at main · franccesco/bloomy-python · 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
site_name: Bloomy Python SDK
site_url: https://github.com/franccesco/bloomy-python/
site_description: Python SDK for Bloom Growth API
site_author: Bloomy Contributors
repo_name: bloomy-python
repo_url: https://github.com/franccesco/bloomy-python
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for 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.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.action.edit
    - content.action.view
  language: en

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: list
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            summary: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - attr_list
  - def_list
  - tables
  - footnotes
  - pymdownx.betterem
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - Authentication: guide/authentication.md
      - Basic Usage: guide/usage.md
      - Bulk Operations: guide/bulk-operations.md
      - Async Support: guide/async.md
      - Error Handling: guide/errors.md
  - API Reference:
      - Client: api/client.md
      - AsyncClient: api/async_client.md
      - Operations:
          - Users: api/operations/users.md
          - Meetings: api/operations/meetings.md
          - Todos: api/operations/todos.md
          - Goals: api/operations/goals.md
          - Scorecard: api/operations/scorecard.md
          - Issues: api/operations/issues.md
          - Headlines: api/operations/headlines.md
      - Configuration: api/configuration.md
      - Exceptions: api/exceptions.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/franccesco/bloomy-python
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/bloomy-python/

copyright: |
  &copy; 2024 <a href="https://github.com/franccesco/bloomy-python" target="_blank" rel="noopener">Bloomy Contributors</a>