Skip to content

Extend API doc generation to include 12 additional SDK modules #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rbren wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Extend API doc generation to include 12 additional SDK modules #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
963b334
Extend API doc generation to include 12 additional SDK modules
openhands-agent Mar 15, 2026
f08123b
Fix broken link/parsing issues and remove testing module
openhands-agent Mar 15, 2026
be89528
Remove malformed Example sections that cause MDX parsing errors
openhands-agent Mar 15, 2026
caa5fb1
Fix class spacing and *args/**kwargs rendering issues
openhands-agent Mar 15, 2026
1a3d2e6
Collapse API Reference section in left navigation by default
openhands-agent Mar 15, 2026
3c4651f
Fix code block preservation and class separator detection
openhands-agent Mar 15, 2026
35ff38b
Fix shell config examples being interpreted as markdown headers
openhands-agent Mar 15, 2026
d8dd824
Nest API Reference modules under collapsed Python SDK section
openhands-agent Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,10 @@
{
"group": "OpenHands Community",
"pages": [
"overview/community",
"overview/contributing",
"overview/faqs",
"openhands/usage/troubleshooting/feedback"
"overview/community",
"overview/contributing",
"overview/faqs",
"openhands/usage/troubleshooting/feedback"
]
}
]
Expand Down Expand Up @@ -384,15 +384,33 @@
},
{
"group": "API Reference",
"collapsed": true,
"pages": [
"sdk/api-reference/openhands.sdk.agent",
"sdk/api-reference/openhands.sdk.conversation",
"sdk/api-reference/openhands.sdk.event",
"sdk/api-reference/openhands.sdk.llm",
"sdk/api-reference/openhands.sdk.security",
"sdk/api-reference/openhands.sdk.tool",
"sdk/api-reference/openhands.sdk.utils",
"sdk/api-reference/openhands.sdk.workspace"
{
"group": "Python SDK",
"collapsed": true,
"pages": [
"sdk/api-reference/openhands.sdk.agent",
"sdk/api-reference/openhands.sdk.context",
"sdk/api-reference/openhands.sdk.conversation",
"sdk/api-reference/openhands.sdk.critic",
"sdk/api-reference/openhands.sdk.event",
"sdk/api-reference/openhands.sdk.hooks",
"sdk/api-reference/openhands.sdk.io",
"sdk/api-reference/openhands.sdk.llm",
"sdk/api-reference/openhands.sdk.logger",
"sdk/api-reference/openhands.sdk.mcp",
"sdk/api-reference/openhands.sdk.observability",
"sdk/api-reference/openhands.sdk.plugin",
"sdk/api-reference/openhands.sdk.secret",
"sdk/api-reference/openhands.sdk.security",
"sdk/api-reference/openhands.sdk.skills",
"sdk/api-reference/openhands.sdk.subagent",
"sdk/api-reference/openhands.sdk.tool",
"sdk/api-reference/openhands.sdk.utils",
"sdk/api-reference/openhands.sdk.workspace"
]
}
]
}
]
Expand Down
Loading
Loading