3bcdfc6b77
Adds a new option that allows the "Other Versions" section to be removed if a project isn't interested in showing links to older versions. The default value is False which means that it will be hidden. Even though the setting is not backward compatible there are enough broken documentation links in the OpenStack projects that this should be opt-in behavior. Change-Id: Ic4b47b19aa9db38557c37aed7722174b7dbdf4a1 Closes-Bug: #1599260
1.2 KiB
1.2 KiB
Using the oslosphinx Theme
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 = 'http://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.