Generate resource type documentation from resource type classes
It should be possible to generate documentation for resource types by introspecting the following:
- docstrings on resource type classes
- documentation attributes on the properties schema
This will keep the documentation close to the code, which at least in theory will help it to stay up-to-date.
This documentation would be consumed by the following:
- Automatic resource type documentation manual generation
- Help text served to clients (cli and gui) via a REST API call
Blueprint information
- Status:
- Complete
- Approver:
- Steven Hardy
- Priority:
- Medium
- Drafter:
- Steve Baker
- Direction:
- Approved
- Assignee:
- Steve Baker
- Definition:
- Approved
- Series goal:
- Accepted for havana
- Implementation:
- Implemented
- Milestone target:
- 2013.2
- Started by
- Thierry Carrez
- Completed by
- Steve Baker
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Sphinx extension to generate resource documentation.
Addressed by: https:/
Auto-document all resource types.
Addressed by: https:/
Functions documentation cleanup.
Addressed by: https:/
Use subsections in resource doc generation.