diff options
author | Doug Hellmann <doug@doughellmann.com> | 2017-02-15 11:57:14 -0500 |
---|---|---|
committer | Doug Hellmann <doug@doughellmann.com> | 2017-02-15 11:58:32 -0500 |
commit | 2f8d5756fb9c5ba7dc0d68e4a5c9ed5d332b4e69 (patch) | |
tree | 5444420716b8cf15913f1164e26d79c5b4c3d659 | |
parent | 63b30027378391235ac1367a2fed83a5758490c0 (diff) | |
download | oslosphinx-2f8d5756fb9c5ba7dc0d68e4a5c9ed5d332b4e69.tar.gz |
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>
-rw-r--r-- | README.rst | 7 | ||||
-rw-r--r-- | doc/source/usage.rst | 15 |
2 files changed, 22 insertions, 0 deletions
@@ -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 diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 89d9a06..54dfd93 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -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. |