[release-announce] [documentation] openstackdocstheme 1.12.0

no-reply at openstack.org no-reply at openstack.org
Mon Jul 3 11:11:13 UTC 2017


We are overjoyed to announce the release of:

openstackdocstheme 1.12.0: OpenStack Docs Theme

The source is available from:

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

Download the package from:

    https://tarballs.openstack.org/openstackdocstheme/

Please report issues through launchpad:

    https://launchpad.net/openstack-doc-tools

For more details, please see below.

1.12.0
^^^^^^

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.


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

* Initial integration of storyboard.openstack.org for report a bug,
  set "bug_project" to the number of the project to use it.

* 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.


Bug Fixes
*********

* If "bug_project" is not set, the "Report a bug" links are not
  displayed at all.

Changes in openstackdocstheme 1.11.0..1.12.0
--------------------------------------------

1d54ae6 Increase admonition.important contrast
1b63fd1 Adds docs for release versions dropdown menu
1aa3997 Adds list of versions in the "Updated" bar
a7c7029 Update docs
d6e6f20 Change name of checkbuild testenv to buildpdf for clarity
a713646 Require bug_project setting
c7b579e Adding octavia api-ref
9a6159a Minimal support for storyboard
fd53ed4 move documentation from readme to sphinx tree
9e7e574 Updated from global requirements
32f6542 Updates "Contents" to "Project home page" to better match existing
6c906c0 Working on integrating options from oslosphinx theme


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

.gitignore                                         |   1 +
README.rst                                         |  62 +-----
...configure_access_and_security_for_instances.rst | 200 --------------------
...configure_access_and_security_for_instances.rst | 200 ++++++++++++++++++++
.../demo/figures/dashboard_admin_project_tab.png   | Bin 0 -> 72705 bytes
.../demo/section_dashboard_access_and_security.rst | 180 ++++++++++++++++++
.../section_dashboard_access_and_security.rst      | 180 ------------------
openstackdocstheme/__init__.py                     |  33 ++++
openstackdocstheme/theme/openstackdocs/layout.html |  20 +-
.../theme/openstackdocs/script_footer.html         |   8 +-
.../theme/openstackdocs/sidebartoc.html            |   2 +-
.../openstackdocs/sidebartoc_menu_apiref.html      |   1 +
.../theme/openstackdocs/static/css/combined.css    |  44 ++++-
.../theme/openstackdocs/static/js/docs.js          |   8 +-
openstackdocstheme/theme/openstackdocs/theme.conf  |   1 +
.../theme/openstackdocs/titlerow.html              |   2 +
.../notes/bug_project-d26160cfe5324694.yaml        |   4 +
.../notes/storyboard-5f67da8941aec6ae.yaml         |   4 +
.../notes/version-dropdown-1aa39974f524dd75.yaml   |  23 +++
test-requirements.txt                              |   2 +-
tox.ini                                            |   8 +-
37 files changed, 1314 insertions(+), 1104 deletions(-)


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

diff --git a/test-requirements.txt b/test-requirements.txt
index 508a411..db88cd8 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8 +8 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-sphinx!=1.6.1,>=1.5.1 # BSD
+sphinx>=1.6.2 # BSD





More information about the Release-announce mailing list