openstack/oslosphinx
Code Issues Proposed changes
a3f3bf8b1d
oslosphinx/doc/source/usage.rst
Doug Hellmann c383e0026a add config option to point to the cgit browser 
Add a configuration option to let projects set the URL to the cgit
browser for their source. Still try to guess at the location based on
our git URL.

Change-Id: I11455f8a137a029c28a864eb555f69f6c282840b
2015-10-16 20:40:02 +00:00

845 B
Raw Blame History

Using the oslosphinx Theme

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

Incubating Projects

If you are an incubating project, set:

html_theme_options = {'incubating': True}

in your conf.py as well, to enable the Incubation theme.

Linking to a Source Repository

oslosphinx defines a configuration option oslosphinx_cgit_link which should be the URL to the git repository browser for the project being documented. The default is a guess, and will be right for a lot of projects, but to ensure that it is correct in all situations it is best to set the value in conf.py:

oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/oslosphinx'