diff options
| -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. |