openstack/oslosphinx
Code Issues Proposed changes
RETIRED, Theme and utilities for Sphinx documentation tool
41 Commits 1 Branch 49 Tags 1.1 MiB
c7e307e359
Go to file
Sean Dague c7e307e359 provide visual separation in sidebar 
Enhance the sidebar display to provide visual distinction between top
level items and lower level items. Top level items are now given a
space above them so they are visually clumped with their children, and
separated from each other. They are also emboldened for greater visual
distinction.

Ideally sphinx would actually tag li items with their depth as a class
tag, but as it currently doesn't do that we can work around it with
setting at ul li, and unsetting at ul li ul li.

Change-Id: I88d4317ec69fe7fd6f5c2198f89de624f0d093da
2014-11-17 09:12:22 -05:00
doc/source Add initial cut for documentation 2014-09-18 12:31:30 -04:00
oslosphinx provide visual separation in sidebar 2014-11-17 09:12:22 -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
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
setup.cfg Report documentation build warnings as errors 2014-09-19 11:32:56 -04:00
setup.py Updated from global requirements 2014-04-30 02:46:02 +00:00
test-requirements.txt Updated from global requirements 2014-10-28 14:05:42 -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.