[release-announce] [documentation] openstackdocstheme 1.17.0

no-reply at openstack.org no-reply at openstack.org
Tue Sep 12 12:34:53 UTC 2017


We are satisfied to announce the release of:

openstackdocstheme 1.17.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.17.0
^^^^^^


Prelude
*******

Adds scoped search so that readers can search within project
documentation only.


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

* Adds ability to use the Sphinx search implementation only for the
  content for the project, such as nova or keystone. The default
  settings set the search scope to within the built version and only
  for .html files.

* Readers access the search functionality through a link to Search
  from the top-most landing page for the project documentation.

Changes in openstackdocstheme 1.16.1..1.17.0
--------------------------------------------

1eaa00b Updated from global requirements
f708d19 Fix link to openstackdays
d83f82d [www] Fix link to COA
a17640a Add support for sphinx sidebar role
5c1714c Remove stray characters from demo
af471ca Update the configuration of generating a PDF document
dddd24c Updated from global requirements
c020af8 Sync language list with openstack-manuals repo
a5ceb6f Bring back local search
8b21fea Cleanup setup.cfg
1c5afab Updated from global requirements
6fbcadb Break cycle dependency with reno
a25417c Updated from global requirements
8454efe Break cycle dependency with os-api-ref
b080d0d Remove navigation.html
0e38191 Update links in README
9b52870 Updated from global requirements
de9b589 Documents how to set conf.py for PDF generation
2e8624f show release series names not version tags
e07ef49 Link to latest version


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

README.rst                                         |  6 +--
openstackdocstheme/__init__.py                     | 59 ++++++++++++++--------
openstackdocstheme/theme/openstackdocs/header.html |  4 +-
openstackdocstheme/theme/openstackdocs/layout.html |  3 +-
.../theme/openstackdocs/navigation.html            | 29 -----------
.../theme/openstackdocs/script_footer.html         | 17 +++++++
openstackdocstheme/theme/openstackdocs/search.html | 19 ++++++-
.../theme/openstackdocs/sidebartoc_menu.html       |  6 ++-
.../theme/openstackdocs/static/css/combined.css    | 20 +++++++-
openstackdocstheme/theme/openstackdocs/theme.conf  |  1 +
.../local-project-search-e6f00a84f2eed0a6.yaml     | 12 +++++
requirements.txt                                   |  1 +
setup.cfg                                          |  9 ++++
test-requirements.txt                              |  4 --
tox.ini                                            |  1 +
18 files changed, 174 insertions(+), 77 deletions(-)


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

diff --git a/requirements.txt b/requirements.txt
index 6de9f4e..f2932ea 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,0 +6 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0
+dulwich>=0.15.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index db88cd8..dfaad59 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -9,4 +8,0 @@ sphinx>=1.6.2 # BSD
-
-reno!=2.3.1,>=1.8.0 # Apache-2.0
-
-os-api-ref>=1.0.0 # Apache-2.0






More information about the Release-announce mailing list