Open Stack

We are enthusiastic to announce the release of:

openstackdocstheme 1.5.0: OpenStack Docs Theme

With source available at:

    http://git.openstack.org/cgit/openstack/openstackdocstheme

Please report issues through launchpad:

    http://bugs.launchpad.net/openstack-manuals

For more details, please see below.

1.5.0
^^^^^

Adds a theme variable, "sidebar_dropdown" to configure the display of
the new API sidebar dropdown menu.


New Features
************

* The automatic table of contents that appears in the body of the
  documentation can be disabled by setting "display_toc" to "False" in
  the "html_theme_options" option in "conf.py".

  For example:

     html_theme_options = {
          "display_toc": False,
     }

* Adds the option to configure the display of a sidebar dropdown
  menu for published API References and Guides. In conf.py, set the
  theme variable, "html_theme_options" to include the parameter,
  "sidebar_dropdown" as "api_ref". For example:

     html_theme_options = {
          "sidebar_dropdown": "api_ref",
       }

  The extensions parameter should include the sphinx extension,
  "os_api_ref".

     extensions = [
         'os_api_ref',
     ]

* Publishes an API Reference demo which is integrated with the API
  sidebar dropdown menu.

Changes in openstackdocstheme 1.4.0..1.5.0
------------------------------------------

4714998 API References dropdown menu
5907244 Allow automatic toc to be disabled


Diffstat (except docs and test files)
-------------------------------------

.gitignore                                         |   1 +
api-ref/source/_static/css/README.md               |   5 +
api-ref/source/conf.py                             | 173 +++++++++++++++++++++
api-ref/source/index.rst                           |   9 ++
api-ref/source/parameters.yaml                     |  24 +++
api-ref/source/service.inc                         | 165 ++++++++++++++++++++
api-ref/source/update-server-resp.json             |   5 +
openstackdocstheme/theme/openstackdocs/js.html     |   4 +-
.../theme/openstackdocs/localtoc.html              |   4 +-
.../theme/openstackdocs/sidebartoc.html            |  23 +--
.../theme/openstackdocs/sidebartoc_menu.html       |  17 ++
.../openstackdocs/sidebartoc_menu_apiref.html      |  19 +++
openstackdocstheme/theme/openstackdocs/theme.conf  |   2 +
...low-disabling-toc-in-body-d98d3a6e633fa28e.yaml |  14 ++
.../sidebar_dropdown_apiref-993b4dba4c0369f6.yaml  |  29 ++++
test-requirements.txt                              |   2 +
tox.ini                                            |  15 +-
18 files changed, 496 insertions(+), 26 deletions(-)


Requirements updates
--------------------

diff --git a/test-requirements.txt b/test-requirements.txt
index 1abb102..1ec5a83 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,0 +11,2 @@ reno>=1.8.0 # Apache2
+
+os-api-ref>=0.4.0 # Apache-2.0