openstack/oslosphinx
Code Issues Proposed changes

add more clear guidelines for when using oslosphinx is appropriate

Browse Source 
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>
This commit is contained in:
Doug Hellmann 2017-02-15 11:57:14 -05:00
parent 63b3002737
commit 2f8d5756fb
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -22,6 +22,13 @@ Team and repository tags
Theme and extension support for Sphinx documentation from the
OpenStack project.
Using the Theme
===============
Prior to using this theme, ensure your project can use the OpenStack
brand by referring to the brand guidelines at
http://www.openstack.org/brand.
* Free software: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/oslosphinx
* Source: http://git.openstack.org/cgit/openstack/oslosphinx

15
doc/source/usage.rst
View File

@ -2,6 +2,21 @@
Using the oslosphinx Theme
============================
Guidelines
==========
Prior to using this theme, ensure your project can use the OpenStack
brand by referring to the brand guidelines at
http://www.openstack.org/brand. In particular, if the project is not
under OpenStack governance as an "official" project, it should not use
this theme.
If your documentation is not being published to an openstack.org site,
that may be a signal that you should not use this theme.
Sphinx Configuration
====================
To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in
the ``conf.py`` file in your Sphinx project.