uipath-python/mkdocs.yml at main · rpapub/uipath-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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
site_name: UiPath SDK
site_url: https://uipath.github.io/uipath-python/

repo_name: UiPath/uipath-python
repo_url: https://github.com/UiPath/uipath-python

copyright: Copyright &copy; 2025 UiPath

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

google_tag_manager_id: GTM-PLLP8P

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo-light.svg
  custom_logo:
    light: assets/logo-light.svg
    dark: assets/logo-dark.svg
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

nav:
  - UiPath SDK:
        - Getting Started: core/getting_started.md
        - Environment Variables: core/environment_variables.md
        - CLI Reference: cli/index.md
        - Tracing: core/traced.md
        - Services:
            - Actions: core/actions.md
            - Assets: core/assets.md
            - Buckets: core/buckets.md
            - Connections: core/connections.md
            - Context Grounding: core/context_grounding.md
            - Documents: core/documents.md
            - Jobs: core/jobs.md
            - LLM Gateway: core/llm_gateway.md
            - Queues: core/queues.md
            - Processes: core/processes.md
        - Models:
            - Documents: core/documents_models.md
  - UiPath MCP SDK:
      - Getting Started: mcp/quick_start.md
      - How To Pack Binary: mcp/how_to_pack_binary.md
      - Sample MCP Servers: https://github.com/UiPath/uipath-mcp-python/tree/main/samples
  - UiPath Langchain SDK:
      - Getting Started: langchain/quick_start.md
      - Chat Models: langchain/chat_models.md
      - Context Grounding: langchain/context_grounding.md
      - Human In The Loop: langchain/human_in_the_loop.md
      - Sample Agents: https://github.com/UiPath/uipath-langchain-python/tree/main/samples
  - UiPath LlamaIndex SDK:
      - Getting Started: llamaindex/quick_start.md
      - LLMs and Embeddings: llamaindex/llms_and_embeddings.md
      - Context Grounding: llamaindex/context_grounding.md
      - Human In The Loop: llamaindex/human_in_the_loop.md
      - Sample Agents: https://github.com/UiPath/uipath-llamaindex-python/tree/main/samples
  - How To Contribute: CONTRIBUTING.md
  - FAQ: FAQ.md
  - Automation Suite: AutomationSuite.md
  - Release Policy: release_policy.md

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            modernize_annotations: true
            show_signature_annotations: false
            separate_signature: true
            show_overloads: false
            unwrap_annotated: true
            heading_level: 2
            show_root_heading: false
            show_source: false
            show_root_toc_entry: false
            show_symbol_type_toc: true
            show_bases: false
  - mkdocs-simple-hooks:
      hooks:
        on_post_page: "docs.hooks:on_post_page"
  - termynal:
      prompt_literal_start:
        - "$"
        - ">"
  - social
  - open-in-new-tab

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - mkdocs-click
  - pymdownx.blocks.tab:
      alternate_style: true
  - pymdownx.blocks.admonition:
      types:
        - note
        - attention
        - caution
        - danger
        - error
        - tip
        - hint
        - warning
        - info
        - check
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.snippets
  - pymdownx.fancylists
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      title: On this page
      permalink: true