openstack/oslosphinx
Code Issues Proposed changes
RETIRED, Theme and utilities for Sphinx documentation tool
38 Commits 1 Branch 49 Tags 1.1 MiB
64fe08f931
Go to file
Doug Hellmann 64fe08f931 Add pbr to installation requirements 
Add pbr to the list of installation requirements so that it is installed
via pip before this library is installed, instead of with easy_install.
This avoids issues like Bug #1384919, and ensures that projects that use
this library as a dependency are properly installed.

Change-Id: I6c155370dbd01fe4748d5137bdf288e8d3e1a67e
2014-10-24 09:32:21 -04:00
doc/source Add initial cut for documentation 2014-09-18 12:31:30 -04:00
oslosphinx Fixed link text colour for incubation variant 2014-07-07 17:44:18 +01: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
CONTRIBUTING.rst Add initial cut for documentation 2014-09-18 12:31:30 -04: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 Add pbr to installation requirements 2014-10-24 09:32:21 -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 Add initial cut for documentation 2014-09-18 12:31:30 -04:00
tox.ini Add initial cut for documentation 2014-09-18 12:31:30 -04: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.