aiosalesforce/mkdocs.yml at main · georgebv/aiosalesforce · 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
site_name: aiosalesforce
site_url: https://georgebv.github.io/aiosalesforce/
repo_url: https://github.com/georgebv/aiosalesforce
repo_name: georgebv/aiosalesforce
site_description: Documentation for aiosalesforce, a Python library for Salesforce API
site_author: George Bocharov
copyright: Copyright &copy; 2024 George Bocharov

nav:
  - Getting Started: index.md
  - Documentation:
      - Introduction: documentation/introduction.md
      - Authentication: documentation/authentication.md
      - Salesforce Client: documentation/client.md
      - SOQL Queries: documentation/soql.md
      - sObject Operations: documentation/sobject.md
      - Composite API:
          - Overview: documentation/composite/overview.md
          - Batch: documentation/composite/batch.md
          - Composite: documentation/composite/composite.md
      - Bulk API:
          - Bulk API: documentation/bulk/v1.md
          - Bulk API 2.0: documentation/bulk/v2.md
      # TODO Handling Exceptions
  - API Reference:
      - Authentication: api-reference/auth.md
      - Salesforce Client: api-reference/client.md
      - Sobject Client: api-reference/sobject.md
      - Composite API:
          - Client: api-reference/composite/client.md
          - Batch: api-reference/composite/batch.md
          - Composite: api-reference/composite/composite.md
          - Exceptions: api-reference/composite/exceptions.md
      - Bulk API 2.0:
          - Client: api-reference/bulk/v2/client.md
          - Ingest Client: api-reference/bulk/v2/ingest.md
          - CSV: api-reference/bulk/v2/csv.md
      - Events: api-reference/events.md
      - Retries: api-reference/retries.md
      - Exceptions: api-reference/exceptions.md
      - Utilities: api-reference/utils.md

theme:
  name: material
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.top
    - search.suggest
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/cloud-bolt

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_toc_entry: false
            docstring_style: "numpy"
            members_order: "source"

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/georgebv/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/gbocharov/

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - tables
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - css/extra.css