OpenStack themed sphinx extension

Registered by Mark McLoughlin on 2013-06-28

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:
milestone icon 2013.2
Started by
Mark McLoughlin on 2013-06-28
Completed by
Mark McLoughlin on 2013-07-09

Related branches

Sprints

Whiteboard

To be clear, all credit goes to Doug on this - I just copied and pasted the info above from email -- markmc

See https://pypi.python.org/pypi/oslo.sphinx

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.