XSpoonAi Documentation Generator
A high-impact skill that parses Python source code and generates a standardized Markdown API reference. It utilizes AST parsing to extract docstrings, function signatures, and class structures.
Quick Start
# Generate docs for a file
result = await agent.run_tool("generate_docs", file_path="src/client.py")
print(result)
Scripts
| Script | Purpose |
|---|---|
| doc_gen.py | Generates Markdown documentation from Python files |
Environment Variables
None required. Uses standard library ast.
Best Practices
- Ensure your code has partial docstrings for better output.
- Use this to keep
README.mdorAPI.mdup to date automatically.