OpenStack themed sphinx extension
This is about extracting the OpenStack theme from the various projects so we only need to have one copy of it. We may also move the code that auto-generates the API doc stub files into the library, since that is also copied into several projects.
The new library will be called oslo.sphinx and its API will be used by adding "oslo.sphinx" to the list of extensions in the sphinx conf.py file for the doc project.
There is one template, with a couple of blocks that can be overridden (those need to be documented).
There is no importable code, yet, and we don't anticipate any.
There will be a configuration setting to turn the API stub generation on and off, when that code is brought in.
Blueprint information
- Status:
- Complete
- Approver:
- Mark McLoughlin
- Priority:
- Medium
- Drafter:
- Doug Hellmann
- Direction:
- Needs approval
- Assignee:
- Doug Hellmann
- Definition:
- Approved
- Series goal:
- Accepted for havana
- Implementation:
- Implemented
- Milestone target:
- 2013.2
- Started by
- Mark McLoughlin
- Completed by
- Mark McLoughlin
Related branches
Related bugs
Sprints
Whiteboard
To be clear, all credit goes to Doug on this - I just copied and pasted the info above from email -- markmc