openstack/oslosphinx

Go to file

Graham Hayes c144be8993 Added a incubating project config option

This allows projects that are currently incubated to use oslosphinx

To use a project needs to set

'html_theme_options = {'incubating': True}'

in their sphinx conf.py

This is option reflected by changing the side bar to have a bar
at the top that shows 'Incubated Project'

Change-Id: Ib5a06ac1749fec475d326afe19f16fffb8c7d4a7

2014-07-02 13:28:28 -05:00

Added a incubating project config option

2014-07-02 13:28:28 -05:00

.gitignore

Add emacs save files to gitignore

2013-07-05 13:04:56 -04:00

.gitreview

Update .gitreview after repo rename

2014-02-07 20:42:08 +00:00

HACKING.rst

Remove references to oslo.sphinx

2014-02-12 16:41:37 +00:00

LICENSE

Import Sphinx theme for OpenStack

2013-07-03 11:13:33 -04:00

MANIFEST.in

Update manifest to use oslosphinx

2014-03-18 11:27:53 -07:00

README.rst

Added a incubating project config option

2014-07-02 13:28:28 -05:00

requirements.txt

Import Sphinx theme for OpenStack

2013-07-03 11:13:33 -04:00

setup.cfg

Merge "Support building wheels (PEP-427)"

2014-04-25 11:46:59 +00:00

setup.py

Updated from global requirements

2014-04-30 02:46:02 +00:00

test-requirements.txt

Updated from global requirements

2014-06-16 09:52:24 +00:00

tox.ini

Rename package from oslo.sphinx to oslosphinx

2014-02-06 08:59:53 -08:00

README.rst

OpenStack Sphinx Extensions

Theme and extension support for Sphinx documentation from the OpenStack project.

To use the theme, add 'oslosphinx' to the extensions list in the conf.py file in your Sphinx project.

If you are an incubating project, set:

html_theme_options = {'incubating': True} in your conf.py as well, to enable the Incubation theme.