mirror of
https://github.com/johndoe6345789/MetalOS.git
synced 2026-04-24 13:45:02 +00:00
29da2e24d4
- Created ExampleAgent, BuildAgent, TestAgent, LintAgent, DocGenAgent, DeployAgent, DepUpdateAgent, RoadmapAgent under agents/ - Added CLI stubs and READMEs for each agent - Updated AGENTS.md with all agent entries Co-authored-by: openhands <openhands@all-hands.dev>
26 lines
389 B
Markdown
26 lines
389 B
Markdown
# DocGenAgent
|
|
|
|
DocGenAgent generates and optionally validates project documentation using Sphinx.
|
|
|
|
## Requirements
|
|
|
|
- Python 3.6+
|
|
- Sphinx installed
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
./agents/DocGenAgent/main.py [--output-dir DIR]
|
|
```
|
|
|
|
### Options
|
|
|
|
- `-o, --output-dir DIR`: Output directory for generated docs (default: `docs/_build`).
|
|
|
|
## Examples
|
|
|
|
Build docs:
|
|
```bash
|
|
./agents/DocGenAgent/main.py
|
|
```
|