diff options
Diffstat (limited to 'doc/source/usage.rst')
| -rw-r--r-- | doc/source/usage.rst | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 53525c8..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,52 +0,0 @@ -============================ - 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 -https://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. - -Incubating Projects -=================== - -If you are an incubating project, set:: - - html_theme_options = {'incubating': True} - -in your conf.py as well, to enable the Incubation theme. - -Linking to a Source Repository -============================== - -``oslosphinx`` defines a configuration option ``oslosphinx_cgit_link`` -which should be the URL to the git repository browser for the project -being documented. The default is a guess, and will be right for a lot -of projects, but to ensure that it is correct in all situations it is -best to set the value in conf.py:: - - oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/oslosphinx' - -Showing Older Versions of Documentation -======================================= - -``oslosphinx`` can automatically add links for previous versions of your -project's documentation to the sidebar. If this feature is enabled links -will be generated for each git tag. To enable this behavior, set:: - - html_theme_options = {'show_other_versions': True} - -in your conf.py. |