Hello community,
here is the log from the commit of package python-openstackdocstheme for
openSUSE:Factory checked in at 2017-11-27 22:16:38
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-openstackdocstheme (Old)
and /work/SRC/openSUSE:Factory/.python-openstackdocstheme.new (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-openstackdocstheme"
Mon Nov 27 22:16:38 2017 rev:5 rq:545337 version:1.17.0
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-openstackdocstheme/python-openstackdocstheme.changes
2017-08-28 15:32:24.332200828 +0200
+++
/work/SRC/openSUSE:Factory/.python-openstackdocstheme.new/python-openstackdocstheme.changes
2017-11-27 22:16:42.794332353 +0100
@@ -1,0 +2,23 @@
+Tue Nov 21 09:46:54 UTC 2017 - [email protected]
+
+- update to version 1.17.0
+ - Documents how to set conf.py for PDF generation
+ - Remove navigation.html
+ - Fix link to openstackdays
+ - Update links in README
+ - Update the configuration of generating a PDF document
+ - Break cycle dependency with reno
+ - Cleanup setup.cfg
+ - Sync language list with openstack-manuals repo
+ - Add support for sphinx sidebar role
+ - [www] Fix link to COA
+ - Bring back local search
+ - Break cycle dependency with os-api-ref
+ - Remove stray characters from demo
+ - Link to latest version
+ - Updated from global requirements
+ - show release series names not version tags
+- drop 0001-Break-cycle-dependency-with-reno.patch,
+ 0001-Break-cycle-dependency-with-os-api-ref.patch: upstream
+
+-------------------------------------------------------------------
Old:
----
0001-Break-cycle-dependency-with-os-api-ref.patch
0001-Break-cycle-dependency-with-reno.patch
openstackdocstheme-1.16.1.tar.gz
New:
----
openstackdocstheme-1.17.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-openstackdocstheme.spec ++++++
--- /var/tmp/diff_new_pack.RygzTl/_old 2017-11-27 22:16:43.706299250 +0100
+++ /var/tmp/diff_new_pack.RygzTl/_new 2017-11-27 22:16:43.710299105 +0100
@@ -16,52 +16,58 @@
#
-%global sname openstackdocstheme
Name: python-openstackdocstheme
-Version: 1.16.1
+Version: 1.17.0
Release: 0
Summary: OpenStack Docs Theme
License: Apache-2.0
Group: Development/Languages/Python
Url: https://launchpad.net/%{sname}
-Source0:
https://pypi.io/packages/source/o/%{sname}/%{sname}-%{version}.tar.gz
-# https://review.openstack.org/491157
-Patch1: 0001-Break-cycle-dependency-with-os-api-ref.patch
-# 0001-Break-cycle-dependency-with-reno.patch
-Patch2: 0001-Break-cycle-dependency-with-reno.patch
+Source0:
https://files.pythonhosted.org/packages/source/o/openstackdocstheme/openstackdocstheme-1.17.0.tar.gz
BuildRequires: openstack-macros
-BuildRequires: python-Sphinx
BuildRequires: python-devel
-BuildRequires: python-pbr >= 2.0.0
-BuildRequires: python-requests >= 2.14.2
-BuildRequires: python-setuptools >= 16.0
+BuildRequires: python2-Sphinx
+BuildRequires: python2-dulwich
+BuildRequires: python2-pbr
+BuildRequires: python2-requests
+BuildRequires: python2-setuptools
+BuildRequires: python3-Sphinx
+BuildRequires: python3-devel
+BuildRequires: python3-dulwich
+BuildRequires: python3-pbr
+BuildRequires: python3-requests
+BuildRequires: python3-setuptools
Requires: python-Sphinx
+Requires: python-dulwich
BuildArch: noarch
+%python_subpackages
%description
Theme and extension support for Sphinx documentation that is published
to docs.openstack.org. Intended for use by OpenStack projects.
%prep
-%autosetup -p1 -n %{sname}-%{version}
+%autosetup -p1 -n openstackdocstheme-1.17.0
# we dont need hacking
sed -i '/^hacking.*/d' test-requirements.txt
%py_req_cleanup
%build
-%py2_build
+%python_build
%install
-%py2_install
+%python_install
%check
-%{__python2} setup.py test
+%{python_expand rm -rf .testrepository
+$python setup.py test
+}
-%files
+%files %{python_files}
%license LICENSE
%doc README.rst
-%{python2_sitelib}/%{sname}
-%{python2_sitelib}/*.egg-info
+%{python_sitelib}/openstackdocstheme
+%{python_sitelib}/openstackdocstheme-*-py?.?.egg-info
%changelog
++++++ _service ++++++
--- /var/tmp/diff_new_pack.RygzTl/_old 2017-11-27 22:16:43.790296201 +0100
+++ /var/tmp/diff_new_pack.RygzTl/_new 2017-11-27 22:16:43.794296056 +0100
@@ -1,8 +1,8 @@
<services>
<service mode="disabled" name="renderspec">
- <param
name="input-template">https://raw.githubusercontent.com/openstack/rpm-packaging/stable/pike/openstack/openstackdocstheme/openstackdocstheme.spec.j2</param>
+ <param
name="input-template">https://raw.githubusercontent.com/openstack/rpm-packaging/master/openstack/openstackdocstheme/openstackdocstheme.spec.j2</param>
<param name="output-name">python-openstackdocstheme.spec</param>
- <param
name="requirements">https://raw.githubusercontent.com/openstack/rpm-packaging/stable/pike/global-requirements.txt</param>
+ <param
name="requirements">https://raw.githubusercontent.com/openstack/rpm-packaging/master/global-requirements.txt</param>
<param name="changelog-email">[email protected]</param>
<param name="changelog-provider">gh,openstack,openstackdocstheme</param>
</service>
++++++ openstackdocstheme-1.16.1.tar.gz -> openstackdocstheme-1.17.0.tar.gz
++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/AUTHORS
new/openstackdocstheme-1.17.0/AUTHORS
--- old/openstackdocstheme-1.16.1/AUTHORS 2017-07-28 14:00:55.000000000
+0200
+++ new/openstackdocstheme-1.17.0/AUTHORS 2017-09-12 14:31:37.000000000
+0200
@@ -41,6 +41,8 @@
Thomas Bechtold <[email protected]>
Tony Breeds <[email protected]>
blue55 <[email protected]>
+chenxing <[email protected]>
gecong1973 <[email protected]>
johnsom <[email protected]>
venkatamahesh <[email protected]>
+zhangdebo1987 <[email protected]>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/ChangeLog
new/openstackdocstheme-1.17.0/ChangeLog
--- old/openstackdocstheme-1.16.1/ChangeLog 2017-07-28 14:00:55.000000000
+0200
+++ new/openstackdocstheme-1.17.0/ChangeLog 2017-09-12 14:31:36.000000000
+0200
@@ -1,6 +1,30 @@
CHANGES
=======
+1.17.0
+------
+
+* Updated from global requirements
+* Fix link to openstackdays
+* [www] Fix link to COA
+* Add support for sphinx sidebar role
+* Remove stray characters from demo
+* Update the configuration of generating a PDF document
+* Updated from global requirements
+* Sync language list with openstack-manuals repo
+* Bring back local search
+* Cleanup setup.cfg
+* Updated from global requirements
+* Break cycle dependency with reno
+* Updated from global requirements
+* Break cycle dependency with os-api-ref
+* Remove navigation.html
+* Update links in README
+* Updated from global requirements
+* Documents how to set conf.py for PDF generation
+* show release series names not version tags
+* Link to latest version
+
1.16.1
------
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/PKG-INFO
new/openstackdocstheme-1.17.0/PKG-INFO
--- old/openstackdocstheme-1.16.1/PKG-INFO 2017-07-28 14:00:55.000000000
+0200
+++ new/openstackdocstheme-1.17.0/PKG-INFO 2017-09-12 14:31:37.000000000
+0200
@@ -1,17 +1,18 @@
Metadata-Version: 1.1
Name: openstackdocstheme
-Version: 1.16.1
+Version: 1.17.0
Summary: OpenStack Docs Theme
Home-page: http://docs.openstack.org/
Author: OpenStack
Author-email: [email protected]
License: UNKNOWN
+Description-Content-Type: UNKNOWN
Description: ========================
Team and repository tags
========================
- .. image::
https://governance.openstack.org/badges/openstackdocstheme.svg
- :target: https://governance.openstack.org/reference/tags/index.html
+ .. image::
https://governance.openstack.org/tc/badges/openstackdocstheme.svg
+ :target:
https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
@@ -23,7 +24,7 @@
Intended for use by OpenStack `projects governed by the Technical
Committee`_.
- .. _`projects governed by the Technical Committee`:
https://governance.openstack.org/reference/projects/index.html
+ .. _`projects governed by the Technical Committee`:
https://governance.openstack.org/tc/reference/projects/index.html
* Free software: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/openstackdocstheme/latest/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/README.rst
new/openstackdocstheme-1.17.0/README.rst
--- old/openstackdocstheme-1.16.1/README.rst 2017-07-28 13:59:03.000000000
+0200
+++ new/openstackdocstheme-1.17.0/README.rst 2017-09-12 14:29:49.000000000
+0200
@@ -2,8 +2,8 @@
Team and repository tags
========================
-.. image:: https://governance.openstack.org/badges/openstackdocstheme.svg
- :target: https://governance.openstack.org/reference/tags/index.html
+.. image:: https://governance.openstack.org/tc/badges/openstackdocstheme.svg
+ :target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
@@ -15,7 +15,7 @@
Intended for use by OpenStack `projects governed by the Technical Committee`_.
-.. _`projects governed by the Technical Committee`:
https://governance.openstack.org/reference/projects/index.html
+.. _`projects governed by the Technical Committee`:
https://governance.openstack.org/tc/reference/projects/index.html
* Free software: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/openstackdocstheme/latest/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/doc/source/demo/create_and_manage_databases.rst
new/openstackdocstheme-1.17.0/doc/source/demo/create_and_manage_databases.rst
---
old/openstackdocstheme-1.16.1/doc/source/demo/create_and_manage_databases.rst
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/doc/source/demo/create_and_manage_databases.rst
2017-09-12 14:29:49.000000000 +0200
@@ -12,7 +12,7 @@
Create a database instance
~~~~~~~~~~~~~~~~~~~~~~~~~~
-**Prerequisites. **\ Before you create a database instance, you need to
+**Prerequisites.** Before you create a database instance, you need to
configure a default datastore and make sure you have an appropriate
flavor for the type of database instance you want.
@@ -53,7 +53,7 @@
Make sure an appropriate flavor exists for the type of
database instance you want.
-**Create database instance. **\ Once you have configured a default
+**Create database instance.** Once you have configured a default
datastore and verified that you have an appropriate flavor, you can
create a database instance.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/doc/source/demo/index.rst
new/openstackdocstheme-1.17.0/doc/source/demo/index.rst
--- old/openstackdocstheme-1.16.1/doc/source/demo/index.rst 2017-07-28
13:59:03.000000000 +0200
+++ new/openstackdocstheme-1.17.0/doc/source/demo/index.rst 2017-09-12
14:29:49.000000000 +0200
@@ -11,6 +11,12 @@
The demo documentation provides example markup for looking at the expected
output.
+.. sidebar:: Sidebar
+
+ This is a sidebar which may be used to provide related or reference
+ material. It is displayed in proximity to, but outside the main
+ text.
+
The project aims for simple implementation, massive scalability, and a rich set
of features. Cloud computing experts from around the world contribute to the
project.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/doc/source/index.rst
new/openstackdocstheme-1.17.0/doc/source/index.rst
--- old/openstackdocstheme-1.16.1/doc/source/index.rst 2017-07-28
13:59:03.000000000 +0200
+++ new/openstackdocstheme-1.17.0/doc/source/index.rst 2017-09-12
14:29:49.000000000 +0200
@@ -101,17 +101,49 @@
html_theme_options = {"show_other_versions": "True"}
- .. warning::
+#. If you are using this theme for a project with published
+ documentation that predates the mitaka release cycle, set the
+ ``earliest_published_series`` theme option to the name of the first
+ series with documentation available.::
- Use this only if the last *5* tagged versions are accessible
- from the html path where the documents are currently published.
- Remember that the OpenStack infra scripts publish now to
- ``docs.openstack.org/REPO/latest`` and
- ``docs.openstack.org/REPO/TAG``. Thus, check first that the
- URLs are correct for your repository before using this option.
+ html_theme_options = {
+ # ...
+ "earliest_published_series": "grizzly",
+ # ...
+ }
- Do not use this for release-notes as they are always published
- as one document with internal versioning.
+ .. warning::
+
+ Do not use this for release-notes as they are always published
+ as one document with internal versioning.
+
+#. To generate a PDF document using ``openstackdocstheme``, add a latex
+ preamble to properly use OpenStack logo image and a font file,
+ and make sure that release, title, and author information is correctly
+ set in the `conf.py` file::
+
+ pdf_theme_path = openstackdocstheme.get_pdf_theme_path()
+ openstack_logo = openstackdocstheme.get_openstack_logo_path()
+
+ latex_custom_template = r"""
+ \newcommand{\openstacklogo}{%s}
+ \usepackage{%s}
+ """ % (openstack_logo, pdf_theme_path)
+
+ latex_elements = {
+ # ...
+ # Additional stuff for the LaTeX preamble.
+ 'preamble': latex_custom_template,
+ }
+
+ release = '15.0.0'
+
+ latex_documents = [
+ ('index', '[Output_filename].tex', u'[Title]',
+ u'OpenStack contributors', 'manual'),
+ ]
+
+ latex_engine = 'xelatex'
Demonstration example
=====================
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/__init__.py
new/openstackdocstheme-1.17.0/openstackdocstheme/__init__.py
--- old/openstackdocstheme-1.16.1/openstackdocstheme/__init__.py
2017-07-28 13:59:03.000000000 +0200
+++ new/openstackdocstheme-1.17.0/openstackdocstheme/__init__.py
2017-09-12 14:29:49.000000000 +0200
@@ -13,9 +13,10 @@
# under the License.
import os
-import string
import subprocess
+import dulwich.repo
+
_giturl = 'https://git.openstack.org/cgit/{}/tree/doc/source'
_html_context_data = None
@@ -24,28 +25,42 @@
if not app.config.html_theme_options.get('show_other_versions', False):
return []
- git_cmd = ["git", "tag", "--sort=v:refname", "--merged"]
+ all_series = []
try:
- raw_version_list = subprocess.Popen(
- git_cmd, stdout=subprocess.PIPE).communicate()[0]
- raw_version_list = raw_version_list.decode("utf-8")
- except UnicodeDecodeError:
- app.warn('Cannot decode the list based on utf-8 encoding. '
- 'Not setting "other_versions".')
- raw_version_list = u''
- except OSError:
- app.warn('Cannot get tags from git repository, or no merged tags. '
- 'Not setting "other_versions".')
- raw_version_list = u''
-
- # grab last five that start with a number and reverse the order
- _tags = [t.strip("'") for t in raw_version_list.split('\n')]
- other_versions = [
- t for t in _tags if t and t[0] in string.digits
- # Don't show alpha, beta or release candidate tags
- and 'rc' not in t and 'a' not in t and 'b' not in t
- ][:-5:-1]
- return other_versions
+ repo = dulwich.repo.Repo.discover()
+ except dulwich.repo.NotGitRepository:
+ return []
+
+ refs = repo.get_refs()
+ for ref in refs.keys():
+ ref = ref.decode('utf-8')
+ if ref.startswith('refs/remotes/origin/stable'):
+ series = ref.rpartition('/')[-1]
+ all_series.append(series)
+ elif ref.startswith('refs/tags/') and ref.endswith('-eol'):
+ series = ref.rpartition('/')[-1][:-4]
+ all_series.append(series)
+ all_series.sort()
+
+ # NOTE(dhellmann): Given when this feature was implemented, we
+ # assume that the earliest version we can link to is for
+ # mitaka. Projects that have older docs online can set the option
+ # to indicate another start point. Projects that come later should
+ # automatically include everything they actually have available
+ # because the start point is not present in the list.
+ earliest_desired = app.config.html_theme_options.get(
+ 'earliest_published_series', 'mitaka')
+ if earliest_desired and earliest_desired in all_series:
+ interesting_series = all_series[all_series.index(earliest_desired):]
+ else:
+ interesting_series = all_series
+
+ # Reverse the list because we want the most recent to appear at
+ # the top of the dropdown. The "latest" release is added to the
+ # front of the list by the theme so we do not need to add it
+ # here.
+ interesting_series.reverse()
+ return interesting_series
def builder_inited(app):
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/header.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/header.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/header.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/header.html
2017-09-12 14:29:50.000000000 +0200
@@ -77,14 +77,14 @@
<li role="presentation"><a role="menuitem" tabindex="-1"
href="//www.openstack.org/community/events/">Overview</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/summit/";>The OpenStack Summit</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="//www.openstack.org/community/events/">More OpenStack Events</a></li>
- <li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/events/#openstack_days";>OpenStack
Days</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/events/openstackdays";>OpenStack
Days</a></li>
</ul>
</li>
<li>
<a href="https://www.openstack.org/learn/"; class="drop"
id="dropdownMenuLearn">Learn <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu"
aria-labelledby="dropdownMenuEvents">
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/training/";>Training</a></li>
- <li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/coa/";>Get Certified</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/coa/";>Get Certified</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="//ask.openstack.org">Ask a Technical Question</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="//superuser.openstack.org">Superuser Magazine</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/videos/";>Summit Videos</a></li>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/layout.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/layout.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/layout.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/layout.html
2017-09-12 14:29:49.000000000 +0200
@@ -43,7 +43,7 @@
<div class="version-dropdown">
<span>{{ _('version') }}</span>
<div class="version-dropdown-content">
- <p><a href="{{ pathto(master_doc) }}"
rel="nofollow">Current</a></p>
+ <p><a href="../latest/" rel="nofollow">Latest</a></p>
{%- for ver in other_versions: %}
<p><a href="../{{pathto(ver, 1) }}" rel="nofollow">{{ ver
}}</a></p>
{%- endfor %}
@@ -93,5 +93,6 @@
</div>
{% include 'footer.html' %}
{% include 'script_footer.html' %}
+{% block script_footer %}{% endblock %}
</body>
</html>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/navigation.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/navigation.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/navigation.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/navigation.html
1970-01-01 01:00:00.000000000 +0100
@@ -1,29 +0,0 @@
-<ul id="Menu1">
- <li>
- <a href="http://www.openstack.org/"; title="Go to the OpenStack Home
page">Home</a>
- </li>
- <li>
- <a class="link" href="http://www.openstack.org/software/"; title="About
OpenStack">About</a>
- </li>
- <li>
- <a class="link" href="http://www.openstack.org/user-stories/"; title="Read
stories about companies that use OpenStack to get work done.">User Stories</a>
- </li>
- <li>
- <a class="link" href="http://www.openstack.org/community/"; title="Go to
the OpenStack Community page">Community</a>
- </li>
- <li>
- <a class="link" href="http://www.openstack.org/profile/"; title="Edit your
OpenStack community profile">Profile</a>
- </li>
- <li>
- <a href="http://www.openstack.org/blog/"; title="Go to the OpenStack
Blog">Blog</a>
- </li>
- <li>
- <a href="http://wiki.openstack.org/"; title="Go to the OpenStack
Wiki">Wiki</a>
- </li>
- <li>
- <a href="http://docs.openstack.org/glossary/content/glossary.html";
title="See definitions of OpenStack terms">Glossary</a>
- </li>
- <li>
- <a class="current" href="http://docs.openstack.org/"; title="Go to the
OpenStack Documentation">Documentation</a>
- </li>
-</ul>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/script_footer.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/script_footer.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/script_footer.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/script_footer.html
2017-09-12 14:29:49.000000000 +0200
@@ -13,6 +13,23 @@
<!-- Popovers -->
<script type="text/javascript" src="{{pathto('_static/js/webui-popover.js',
1)}}"></script>
+<!-- standard sphinx include libraries, which allow search highlighting -->
+<script type="text/javascript" src="{{pathto('_static/underscore.js',
1)}}"></script>
+<script type="text/javascript" src="{{pathto('_static/doctools.js',
1)}}"></script>
+<script type="text/javascript" src="{{pathto('_static/searchtools.js',
1)}}"></script>
+
+<script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '{{ version }}',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ SOURCELINK_SUFFIX: '.txt',
+ HAS_SOURCE: true
+ };
+</script>
+
+
<!-- Javascript for page -->
<script language="JavaScript">
/* build a description of this page including SHA, source location on git repo,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/search.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/search.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/search.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/search.html
2017-09-12 14:29:49.000000000 +0200
@@ -21,8 +21,23 @@
</p>
</div>
<p>
- {% trans %}To search the OpenStack documentation, type your query into the
+ {% trans %}To search the documentation for {{ project }}, type your query
into the
box below and press Enter.{% endtrans %}
</p>
- {% include 'swiftype_search.html' %}
+ <form action="" method="get">
+ <input type="text" name="q" value="" />
+ <input type="submit" value="search" />
+ <span id="search-progress" style="padding-left: 10px"></span>
+
+ <div id="search-results">
+
+ </div>
+{% endblock %}
+
+{% block script_footer %}
+ <script type="text/javascript">
+ jQuery(function() { Search.loadIndex("searchindex.js"); });
+ </script>
+
+ <script type="text/javascript" id="searchindexloader"></script>
{% endblock %}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/sidebartoc_menu.html
2017-09-12 14:29:49.000000000 +0200
@@ -8,10 +8,12 @@
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/index.html#api-guides";>API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/index.html#contributor-guides";>Contributor
Guides</a></li>
<li role="presentation" class="dropdown-header">Languages</li>
- <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/ja/";>日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/de/";>Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/fr/";>Français (French)</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/id/";>Bahasa Indonesia (Indonesian)</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/it/";>Italiano (Italian)</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/ja/";>日本語 (Japanese)</a></li>
+ <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/ko_KR/";>한국어 (Korean)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/pt_BR/";>Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/zh_CN/";>简体中文 (Simplified Chinese)</a></li>
- <li role="presentation"><a role="menuitem" tabindex="-1"
href="http://docs.openstack.org/ko_KR/";>한국어 (Korean)</a></li>
</ul>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/static/css/combined.css
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/static/css/combined.css
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/static/css/combined.css
2017-07-28 13:59:04.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/static/css/combined.css
2017-09-12 14:29:49.000000000 +0200
@@ -1778,7 +1778,7 @@
.footer-links h3 {
color: #fff;
- font-size: 14px;
+ font-size: 14px;
}
.footer-links ul {
@@ -4165,6 +4165,19 @@
.popover {
color: #2A4E68; }
+div.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px 7px 0 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
.admonition {
background: #eee;
border-left: 4px solid;
@@ -4653,6 +4666,11 @@
margin-right: 0;
}
+/* for search result highlighting */
+span.highlighted {
+ background-color: #fbe54e;
+}
+
/*img.align-left {*/
/* display: table;*/
/* margin-left: 0;*/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/theme.conf
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/theme.conf
---
old/openstackdocstheme-1.16.1/openstackdocstheme/theme/openstackdocs/theme.conf
2017-07-28 13:59:03.000000000 +0200
+++
new/openstackdocstheme-1.17.0/openstackdocstheme/theme/openstackdocs/theme.conf
2017-09-12 14:29:49.000000000 +0200
@@ -9,3 +9,4 @@
display_toc = True
sidebar_dropdown = os_docs
show_other_versions = False
+earliest_published_series = mitaka
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/PKG-INFO
new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/PKG-INFO
--- old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/PKG-INFO
2017-07-28 14:00:55.000000000 +0200
+++ new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/PKG-INFO
2017-09-12 14:31:37.000000000 +0200
@@ -1,17 +1,18 @@
Metadata-Version: 1.1
Name: openstackdocstheme
-Version: 1.16.1
+Version: 1.17.0
Summary: OpenStack Docs Theme
Home-page: http://docs.openstack.org/
Author: OpenStack
Author-email: [email protected]
License: UNKNOWN
+Description-Content-Type: UNKNOWN
Description: ========================
Team and repository tags
========================
- .. image::
https://governance.openstack.org/badges/openstackdocstheme.svg
- :target: https://governance.openstack.org/reference/tags/index.html
+ .. image::
https://governance.openstack.org/tc/badges/openstackdocstheme.svg
+ :target:
https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
@@ -23,7 +24,7 @@
Intended for use by OpenStack `projects governed by the Technical
Committee`_.
- .. _`projects governed by the Technical Committee`:
https://governance.openstack.org/reference/projects/index.html
+ .. _`projects governed by the Technical Committee`:
https://governance.openstack.org/tc/reference/projects/index.html
* Free software: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/openstackdocstheme/latest/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/SOURCES.txt
new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/SOURCES.txt
--- old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/SOURCES.txt
2017-07-28 14:00:55.000000000 +0200
+++ new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/SOURCES.txt
2017-09-12 14:31:37.000000000 +0200
@@ -48,7 +48,6 @@
openstackdocstheme/theme/openstackdocs/layout.html
openstackdocstheme/theme/openstackdocs/license_cc.html
openstackdocstheme/theme/openstackdocs/localtoc.html
-openstackdocstheme/theme/openstackdocs/navigation.html
openstackdocstheme/theme/openstackdocs/script_footer.html
openstackdocstheme/theme/openstackdocs/script_search.html
openstackdocstheme/theme/openstackdocs/search.html
@@ -114,6 +113,7 @@
releasenotes/notes/disable_analytics-45d98d6fab71d2b1.yaml
releasenotes/notes/do-not-display-local-toc-title-without-subtitles-4e1fc48705d66289.yaml
releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml
+releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml
releasenotes/notes/lp1516819-b4bb7b0f10004cef.yaml
releasenotes/notes/norelease-ccd7722c078a73a2.yaml
releasenotes/notes/side-bar-config-d7e66388e252cadf.yaml
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/pbr.json
new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/pbr.json
--- old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/pbr.json
2017-07-28 14:00:55.000000000 +0200
+++ new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/pbr.json
2017-09-12 14:31:37.000000000 +0200
@@ -1 +1 @@
-{"git_version": "3f2de78", "is_release": true}
\ No newline at end of file
+{"git_version": "1eaa00b", "is_release": true}
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/requires.txt
new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/requires.txt
--- old/openstackdocstheme-1.16.1/openstackdocstheme.egg-info/requires.txt
2017-07-28 14:00:55.000000000 +0200
+++ new/openstackdocstheme-1.17.0/openstackdocstheme.egg-info/requires.txt
2017-09-12 14:31:37.000000000 +0200
@@ -1 +1,6 @@
pbr!=2.1.0,>=2.0.0
+dulwich>=0.15.0
+
+[test]
+os-api-ref>=1.4.0
+reno>=2.5.0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/openstackdocstheme-1.16.1/releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml
new/openstackdocstheme-1.17.0/releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml
---
old/openstackdocstheme-1.16.1/releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml
1970-01-01 01:00:00.000000000 +0100
+++
new/openstackdocstheme-1.17.0/releasenotes/notes/local-project-search-e6f00a84f2eed0a6.yaml
2017-09-12 14:29:49.000000000 +0200
@@ -0,0 +1,12 @@
+---
+prelude: >
+ Adds scoped search so that readers can search within project documentation
+ only.
+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.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/requirements.txt
new/openstackdocstheme-1.17.0/requirements.txt
--- old/openstackdocstheme-1.16.1/requirements.txt 2017-07-28
13:59:03.000000000 +0200
+++ new/openstackdocstheme-1.17.0/requirements.txt 2017-09-12
14:29:49.000000000 +0200
@@ -3,3 +3,4 @@
# process, which may cause wedges in the gate later.
pbr!=2.1.0,>=2.0.0 # Apache-2.0
+dulwich>=0.15.0 # Apache-2.0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/setup.cfg
new/openstackdocstheme-1.17.0/setup.cfg
--- old/openstackdocstheme-1.16.1/setup.cfg 2017-07-28 14:00:55.000000000
+0200
+++ new/openstackdocstheme-1.17.0/setup.cfg 2017-09-12 14:31:37.000000000
+0200
@@ -19,6 +19,11 @@
Programming Language :: Python :: 3.5
Topic :: Documentation
+[extras]
+test =
+ os-api-ref>=1.4.0 # Apache-2.0
+ reno>=2.5.0 # Apache-2.0
+
[global]
setup-hooks =
pbr.hooks.setup_hook
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/test-requirements.txt
new/openstackdocstheme-1.17.0/test-requirements.txt
--- old/openstackdocstheme-1.16.1/test-requirements.txt 2017-07-28
13:59:03.000000000 +0200
+++ new/openstackdocstheme-1.17.0/test-requirements.txt 2017-09-12
14:29:49.000000000 +0200
@@ -6,7 +6,3 @@
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
-
-reno!=2.3.1,>=1.8.0 # Apache-2.0
-
-os-api-ref>=1.0.0 # Apache-2.0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/openstackdocstheme-1.16.1/tox.ini
new/openstackdocstheme-1.17.0/tox.ini
--- old/openstackdocstheme-1.16.1/tox.ini 2017-07-28 13:59:03.000000000
+0200
+++ new/openstackdocstheme-1.17.0/tox.ini 2017-09-12 14:29:49.000000000
+0200
@@ -6,6 +6,7 @@
usedevelop = False
install_command = {toxinidir}/tools/tox_install.sh
{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
{opts} {packages}
deps = -r{toxinidir}/test-requirements.txt
+ .[test]
setenv = VIRTUAL_ENV={envdir}
BRANCH_NAME=master
CLIENT_NAME=openstackdocstheme
