Skip to content

Feat(sdk, docs): Adding auto-generated python sdk reference #2283

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
jjeliga wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Feat(sdk, docs): Adding auto-generated python sdk reference #2283

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
116c0e6
sdk docs v0
Mar 3, 2026
f42283d
license
Mar 3, 2026
7bb1298
fixed py checks and platform structure
Mar 4, 2026
16db4e1
bredcrumbs
Mar 4, 2026
44fac13
v1
Mar 4, 2026
f4b2cf4
v1 small update
Mar 4, 2026
4bc4733
CR changes
Mar 4, 2026
1f598ed
github ci docs checks extension
Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ There are two documentation folders: `docs/stable` and `docs/development`. Due t

All PRs **must** either include corresponding documentation in `docs/development`, or include `[x] No Docs Needed` in the PR description. This is checked by GitHub Actions.

Special care needs to be taken with the `docs/development/reference/cli-reference.mdx` file, which is automatically generated. Use `mise run agentstack-cli:docs` to regenerate this file when modifying the CLI interface.
Special care needs to be taken with the `docs/development/reference/` folder, as its contents are automatically generated. Use `mise run agentstack-cli:docs` to regenerate the CLI reference when modifying the CLI interface. Use `mise run agentstack-sdk-py:docs` to regenerate the Python SDK reference when making any changes to it; Additionally, modify the corresponding SDK reference generating scripts in `apps/agentstack-sdk-py/docs` and the docs/docs.json file whenever you change the package import structure to reflect those changes.

Try to follow this structure:

Expand Down
695 changes: 695 additions & 0 deletions apps/agentstack-sdk-py/docs/generate_docs.py
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading