openstack/openstackdocstheme
Code Issues Proposed changes

Adds docs for release versions dropdown menu

Browse Source 
Change-Id: I8b080fa4bd8d6bd44b24ff2d050286a7ffe27c97
This commit is contained in:
Anne Gentle 2017-06-30 11:47:45 -04:00
parent 1aa39974f5
commit 1b63fd10c5
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/index.rst
View File

@ -94,6 +94,12 @@ Using the Theme
html_theme_options = {"sidebar_dropdown": "api_ref", html_theme_options = {"sidebar_dropdown": "api_ref",
"sidebar_mode": "toc"} "sidebar_mode": "toc"}
#. If you are using this theme for documentation you want to release based on
git tags on your repository, set the release dropdown menu option in the
`html_theme_options` in the `conf.py` file. By default it is set to False.::
html_theme_options = {"show_other_versions": "True"}
Demonstration example Demonstration example
===================== =====================

23
releasenotes/notes/version-dropdown-1aa39974f524dd75.yaml Normal file
View File

@ -0,0 +1,23 @@
---
prelude: >
Adds ability to show up to the last five versions of the documentation,
based on the available git tags for the repository. Use the theme variable,
``show_other_versions`` to chose to display the available versions in a
dropdown menu.
features:
- |
Adds the option to configure the display of a version selector dropdown
menu for the most recent five git tags used as release indicators for the repository.
By default, in ``theme.conf``, the ``show_other_versions`` value is set to
False.
In ``conf.py``, set the theme variable, ``html_theme_options`` to
include the parameter, ``show_other_versions`` as ``True``. For
example:
::
html_theme_options = {'show_other_versions': True}
- Publishes a version dropdown menu in the "Updated" date row, on both mobile
and desktop views, where the version list is imported from git tags on the
repository.