9 Commits

Author SHA1 Message Date
Doug Hellmann
2f8d5756fb add more clear guidelines for when using oslosphinx is appropriate
Based on the branding guidelines linked in this patch, projects that are
not officially under governance should not use the theme in most
circumstances.

Change-Id: Id6ded25a20965803ddbca0c2e587d3f4c476168f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-02-15 11:58:32 -05:00
Flavio Percoco
f97e6b3a80 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/4db6463001a25510a067b42a3cdf1033\n'

Change-Id: Ibdf60d28bb56c4372a9d8ac76ee3a8196c164523
2016-11-25 13:08:34 +01:00
Eric Brown
8084f2a468 Add version and download badges to README
All the other oslo libraries contain such badges, so might as well
add to oslosphinx too.

Change-Id: I23fa8dc4619940896fb25af39325f076f4dd3e49
2016-02-03 14:49:50 -08:00
Doug Hellmann
6ebaef6ba4 clean up documentation titles and intros
Change-Id: I9f1bf4e912e53500f603cecb23f86b48d5dbc159
2015-09-24 19:42:39 +00:00
Doug Hellmann
c01c226538 Add links to the README
Add a few links to resources for the project so humans can find them but
also so the release notes script will find them.

Change-Id: If5fb9387e9ffb5c9288632beaa1b6d4e90d48033
2014-12-09 17:01:10 -05:00
Doug Hellmann
acd90677ef Tighten up documentation
Remove some mostly empty pages and add a few section headings.

Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fc
2014-10-21 14:56:34 -04:00
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
Ben Nemec
28f4cf00a0 Remove references to oslo.sphinx
There were a few left over in the documentation

Change-Id: I87ca3e6c104798a94874916df355b6bdc74c1408
2014-02-12 16:41:37 +00:00
Doug Hellmann
ac91ff16bc Import Sphinx theme for OpenStack
This is a copy of the Sphinx theme for OpenStack developer
documentation imported from the ceilometer repository. After
this library is released, we will remove the copies of the
theme from all of the other repositories.

blueprint oslo.sphinx

Change-Id: I20b6c224b8d8fbede354c2a28ad67eda3a4b9dac
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-03 11:13:33 -04:00