Skip to content

Commit 557c799

Browse files
chore: update documentation structure
1 parent 800b85e commit 557c799

10 files changed

Lines changed: 1748 additions & 1715 deletions

File tree

.github/workflows/publish-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ jobs:
3939
- name: Clone plugins
4040
run: |
4141
git clone https://x-access-token:${{ secrets.REPO_ACCESS }}@github.com/UiPath/uipath-langchain-python plugins/uipath-langchain-python
42+
git clone https://x-access-token:${{ secrets.REPO_ACCESS }}@github.com/UiPath/uipath-llamaindex-python plugins/uipath-llamaindex-python
4243
4344
- name: Symlink plugin docs
4445
run: |
4546
mkdir -p docs/plugins
4647
ln -s ../../plugins/uipath-langchain-python docs/plugins/uipath-langchain-python
48+
ln -s ../../plugins/uipath-llamaindex-python docs/plugins/uipath-llamaindex-python
4749
4850
- name: Publish Docs
4951
run: uv run mkdocs gh-deploy --force

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,8 @@ wheels/
2222
**/playground.py
2323
**/.idea
2424

25-
**/docs/index.md
2625
**/docs/plugins/*
2726
**/docs/plugins/.*
28-
**/docs/quick_start_images/*
29-
**/docs/quick_start_images/.*
3027

3128
.cache/*
3229
.cache

docs/hooks.py

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
import os
21
import re
3-
import shutil
4-
5-
6-
def on_pre_build(config):
7-
if not os.path.exists("docs/quick_start_images"):
8-
shutil.copy(
9-
"docs/plugins/uipath-langchain-python/docs/quick_start.md", "docs/index.md"
10-
)
11-
shutil.copytree(
12-
"docs/plugins/uipath-langchain-python/docs/quick_start_images",
13-
"docs/quick_start_images",
14-
)
152

163

174
def on_post_page(output, page, config):

docs/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: UiPath SDK
3+
---
4+
5+
<div class="grid cards" markdown>
6+
- __UiPath Langchain SDK__
7+
8+
---
9+
10+
Set up, create, publish, and run your first UiPath-LangChain Agent
11+
12+
[Getting started](./langchain)
13+
14+
- __UiPath LLamaIndex SDK__
15+
16+
---
17+
18+
Set up, create, publish, and run your first UiPath-LLamaIndex Agent
19+
20+
[Getting started](./llamaindex)
21+
22+
</div>

docs/langchain/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
--8<--
2+
docs/plugins/uipath-langchain-python/docs/quick_start.md
3+
--8<--
4+
5+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Content Grounding
3+
---
4+
5+
--8<--
6+
docs/plugins/uipath-llamaindex-python/docs/context_grounding.md
7+
--8<--
8+
9+
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
--8<--
2+
docs/plugins/uipath-llamaindex-python/docs/human_in_the_loop.md
3+
--8<--

docs/llamaindex/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
--8<--
2+
docs/plugins/uipath-llamaindex-python/docs/quick_start.md
3+
--8<--

mkdocs.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,16 @@ theme:
5454

5555
nav:
5656
- UiPath Langchain SDK:
57-
- Getting Started: index.md
57+
- Getting Started: langchain/index.md
5858
- Chat Models: langchain/chat_models.md
5959
- Context Grounding: langchain/context_grounding.md
6060
- Human In The Loop: langchain/human_in_the_loop.md
6161
- Sample Agents: https://github.com/UiPath/uipath-langchain-python/tree/main/samples
62+
- UiPath LLamaIndex SDK:
63+
- Getting Started: llamaindex/index.md
64+
- Context Grounding: llamaindex/context_grounding.md
65+
- Human In The Loop: llamaindex/human_in_the_loop.md
66+
- Sample Agents: https://github.com/UiPath/uipath-llamaindex-python/tree/main/samples
6267
- UiPath SDK:
6368
- Getting Started: core/getting_started.md
6469
- Environment Variables: core/environment_variables.md
@@ -98,7 +103,6 @@ plugins:
98103
show_bases: false
99104
- mkdocs-simple-hooks:
100105
hooks:
101-
on_pre_build: "docs.hooks:on_pre_build"
102106
on_post_page: "docs.hooks:on_post_page"
103107
- termynal:
104108
prompt_literal_start:

uv.lock

Lines changed: 1698 additions & 1697 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)