Generate resource type documentation from resource type classes

Registered by Steve Baker on 2013-03-14

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:
milestone icon 2013.2
Started by
Thierry Carrez on 2013-07-30
Completed by
Steve Baker on 2013-08-01

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/generate-resource-docs,n,z

Addressed by: https://review.openstack.org/38704
    Sphinx extension to generate resource documentation.

Addressed by: https://review.openstack.org/38705
    Auto-document all resource types.

Addressed by: https://review.openstack.org/38889
    Functions documentation cleanup.

Addressed by: https://review.openstack.org/38890
    Use subsections in resource doc generation.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.