Open Stack

We are pleased to announce the release of:

openstackdocstheme 1.4.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.4.0
^^^^^

In preparation for releasing updated API reference documentation using
this theme, we have a collection of new features and fixes.


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

* The ability to customise the bug title for the 'Report a Bug' link
  is now available. To customise the bug title used add the
  "bug_title" key with a value to "html_context" in the Sphinx
  configuration.

  For example:

     html_context = {"bug_title": 'Documentation bug', ...}

* Ensure Javascript and CSS files are pulled in programmatically to
  enable custom Javascript and CSS files.

* CSS adjustments to "inline" markup and contents indentation.

* Enable custom bug title link.

* Adds sidebar_mode for table of contents as an option for
  html_theme_options in conf.py.

* The sidebar Table of Contents can now be set to the full "toc"
  directive, or remain as the "toctree" directive.

  This can be set by setting ""sidebar_mode"" to ""toc"" in the
  "html_theme_options" option in "conf.py".

  For example:

     html_theme_options = {
          "sidebar_mode": "toc",
       }


Bug Fixes
*********

* Use HTTPS for external dependencies.

* Replace deprecated library function os.popen() with subprocess.
  (1529836)

* Update contribute link in footer. (1421814)

* Hide duplicate titles and empty tocs in generated content.

Changes in openstackdocstheme 1.3.0..1.4.0
------------------------------------------

84152e2 Update Release Notes
16c47a0 Adds release notes items for next release
e822907 Make ``something`` more highlighted
13bd976 Allow the bug title to be customisable
ebf3a77 Broken Link
9561d12 Updated from global requirements
710f1d8 Increase indent level of doc top contents
71afab3 Updated from global requirements
b86eddc Actually include custom JS files
75e8fc6 Release note for new sidebar feature
4f70614 Use HTTPS for external deps
7388b01 Set side bar content to be configurable
c8ccaa7 Create empty folder for custom font files
bed0526 Fix text font-family of admonitions.
0593452 Allow for inclusion of custom JS files
a217b4c Updated from global requirements
6c7f8e4 Change summit video URL
9bb0f5e Updated from global requirements
ed6dee2 Update the Administrator Guide link
cd2b088 Clarify uses for this theme
50df6ac Allow cssfiles added by sphinx extensions
c2b3775 Add appropriate order list styles


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

README.rst                                         |   9 +-
RELEASENOTES.rst                                   | 121 --------------------
...configure_access_and_security_for_instances.rst |  35 +++---
openstackdocstheme/theme/openstackdocs/css.html    |   4 +-
openstackdocstheme/theme/openstackdocs/header.html |   2 +-
openstackdocstheme/theme/openstackdocs/js.html     |   5 +
openstackdocstheme/theme/openstackdocs/layout.html |   4 +
.../theme/openstackdocs/localtoc.html              |   2 +
.../theme/openstackdocs/script_footer.html         |   6 +-
.../theme/openstackdocs/sidebartoc.html            |   4 +
.../theme/openstackdocs/static/css/combined.css    |  49 +++++---
.../theme/openstackdocs/static/fonts/.gitkeep      |   0
.../theme/openstackdocs/static/js/docs.js          |  16 +--
openstackdocstheme/theme/openstackdocs/theme.conf  |   1 +
releasenotes/notes/bug-title-fdbefea0408e2cbf.yaml |  13 +++
.../notes/custom-bug-link-ec64bdf9ce357d16.yaml    |  18 +++
.../notes/side-bar-config-d7e66388e252cadf.yaml    |  16 +++
releasenotes/source/current.rst                    |   5 +
releasenotes/source/historic.rst                   | 125 +++++++++++++++++++++
releasenotes/source/index.rst                      |   3 +-
releasenotes/source/unreleased.rst                 |   5 -
requirements.txt                                   |   2 +-
test-requirements.txt                              |   4 +-
25 files changed, 290 insertions(+), 201 deletions(-)


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

diff --git a/requirements.txt b/requirements.txt
index 11bed1e..7dfa598 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -6 +6 @@ pbr>=1.6 # Apache-2.0
-requests!=2.9.0,>=2.8.1 # Apache-2.0
+requests>=2.10.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 51cd316..1abb102 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8 +8 @@ hacking<0.11,>=0.10.0
-sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
+sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
@@ -10 +10 @@ sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
-reno>=0.1.1 # Apache2
+reno>=1.8.0 # Apache2