-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
Description
Parent Issue
Part of #273 - .vx.toml v2 Configuration Enhancement
Objective
Add configuration for automatic documentation generation.
Configuration Format
[docs]
enabled = true
output = "docs/generated"
[docs.api]
generator = "typedoc" # typedoc | sphinx | godoc | rustdoc
source = "src"
output = "docs/api"
[docs.changelog]
generator = "conventional-changelog"
preset = "angular"
[docs.readme]
badges = ["ci", "coverage", "version", "license"]
sections = ["installation", "usage", "api", "contributing"]Tasks
- Define
DocsConfigstructure - Implement
vx docs generatecommand - Add API documentation generation
- Add changelog generation from commits
- Add README badge/section updates
- Support multiple documentation generators
- Add unit tests
Commands
vx docs generate # Generate all docs
vx docs api # Generate API docs only
vx docs changelog # Generate changelog
vx docs readme # Update READMEAcceptance Criteria
- API docs generated correctly
- Changelog follows conventional commits
- README badges are valid
- Multiple generators supported