docs-mintlify/pyproject.toml at main · askui/docs-mintlify · 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
[project]
name = "docs-mintlify"
version = "0.1.0"
description = "For generating docs for python projects"
authors = [
    {name = "Dominik Klotz", email = "dominik.klotz@askui.com"},
]
dependencies = []
requires-python = "==3.13.*"
readme = "README.md"
license = {text = "MIT"}


[tool.pdm]
distribution = false

[tool.pdm.scripts]
"docs:api:generate" = {shell  = "pydoc-markdown"}

[[tool.pydoc-markdown.loaders]]
type = "python"
packages = [ "askui" ]
modules = [ "askui" ]

[tool.pydoc-markdown.renderer]
type = "hugo"
content_directory = "02-api-reference/01-agent-frameworks/02-python/02-vision-agent-api"

[tool.pydoc-markdown.renderer.markdown]
classdef_with_decorators = false
signature_with_decorators = false
data_code_block = true
descriptive_class_title = false
render_module_header = true
format_code_style = "facebook"
add_full_prefix = true
sub_prefix = true
header_level_by_type = {Module = 1, Class = 2, Method = 4, Function = 4, Variable = 4}

[[tool.pydoc-markdown.renderer.pages]]
title = "Agent"
name = "agent"
contents = [
    "askui.agent.VisionAgent.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Android Vision Agent"
name = "android-vision-agent"
contents = [
    "askui.android_agent.AndroidVisionAgent.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Agent Base"
name = "agent-base"
contents = [
    "askui.agent_base.AgentBase.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Locators"
name = "locators"
contents = [
    "askui.locators.relatable.ReferencePoint",
    "askui.locators.relatable.RelationIndex",
    "askui.locators.locators.TextMatchType",
    "askui.locators.relatable.CircularDependencyError",
    "askui.locators.locators.AiElement",
    "askui.locators.locators.Element",
    "askui.locators.locators.Image",
    "askui.locators.locators.Prompt",
    "askui.locators.locators.Text",
    "askui.locators.locators.Locator",
    "askui.locators.relatable.Relatable.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Reporting"
name = "reporting"
contents = [
    "askui.reporting.*",
]
[[tool.pydoc-markdown.renderer.pages]]
title = "Retry"
name = "retry"
contents = [
    "askui.retry.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Tools"
name = "tools"
contents = [
    "askui.tools.agent_os.AgentOs.*",
    "askui.tools.anthropic.base.ToolError",
    "askui.tools.anthropic.base.ToolResult",
    "askui.tools.askui.askui_controller.AskUiControllerServer.*",
    "askui.tools.askui.askui_controller.AskUiControllerClient.*",
    "askui.tools.askui.exceptions.*",
]

[[tool.pydoc-markdown.renderer.pages]]
title = "Types"
name = "types"
contents = [
    "askui.models.models.ActModel",
    "askui.models.models.GetModel",
    "askui.models.models.LocateModel",
    "askui.models.openrouter.handler.OpenRouterGetModel",
    "askui.models.openrouter.settings.OpenRouterSettings",
    "askui.models.models.Model",
    "askui.models.models.ModelName",
    "askui.models.models.ModelComposition",
    "askui.models.models.ModelDefinition",
    "askui.models.models.ModelRegistry",
    "askui.models.models.Point",
    "askui.models.types.response_schemas.ResponseSchema",
    "askui.models.types.response_schemas.ResponseSchemaBase",
    "askui.tools.agent_os.ModifierKey",
    "askui.tools.agent_os.PcKey",
    "askui.utils.image_utils.Img",
    "askui.utils.image_utils.ImageSource",
    "askui.models.exceptions.*",
    "askui.models.askui.exceptions.*",                        # added to `askui.exceptions`
    "askui.models.askui.ai_element_utils.AiElementNotFound",  # added to `askui.exceptions`
    # AgentToolbox and ModelRouter (parameter of VisionAgent.__init__()) currently not included
    # as they are mainly used for internal testing and have a lot of dependencies which would
    # bloat the docs
]

[dependency-groups]
dev = [
    "pydoc-markdown>=4.8.2",
    "askui>=0.22.2",
]