From 960b5ce20749e682b5d1263162f5791593d9cc0f Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 25 Jul 2013 18:21:53 +0800 Subject: [PATCH 001/192] Initial debian folder. --- debian/changelog | 5 +++++ debian/compat | 1 + debian/control | 24 ++++++++++++++++++++++++ debian/copyright | 31 +++++++++++++++++++++++++++++++ debian/gbp.conf | 8 ++++++++ debian/rules | 9 +++++++++ debian/source/format | 1 + debian/watch | 2 ++ 8 files changed, 81 insertions(+) create mode 100644 debian/changelog create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100644 debian/gbp.conf create mode 100755 debian/rules create mode 100644 debian/source/format create mode 100644 debian/watch diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..218fca1 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +oslo-sphinx (1.0-1) unstable; urgency=low + + * Initial release (Closes: #717809). + + -- Thomas Goirand Thu, 25 Jul 2013 17:57:32 +0800 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..54bc151 --- /dev/null +++ b/debian/control @@ -0,0 +1,24 @@ +Source: oslo-sphinx +Section: python +Priority: optional +Maintainer: PKG OpenStack +Uploaders: Julien Danjou , + Thomas Goirand , + Mehdi Abaakouk +Build-Depends: debhelper (>= 9), + openstack-pkg-tools, + python-all (>= 2.6.6-3~), + python-setuptools +Build-Depends-Indep: python-d2to1, python-pbr +Standards-Version: 3.9.4 +Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git +Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git +Homepage: https://github.com/openstack/oslo.sphinx + +Package: python-oslo.sphinx +Architecture: all +Pre-Depends: dpkg (>= 1.15.6~) +Depends: ${misc:Depends}, ${python:Depends} +Description: theme and extension support for openstack + Theme and extension support for Sphinx documentation from the OpenStack + project. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..cdaa4b8 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,31 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: oslo.sphinx +Source: git://github.com/openstack/oslo.sphinx.git + +Files: debian/* +Copyright: (c) 2013, Thomas Goirand +License: Apache-2.0 + +Files: * +Copyright: (c) 2013, Monty Taylor + (c) 2013, Doug Hellmann + (c) 2007-2011, by the Sphinx team + (c) 2013, New Dream Network, LLC (DreamHost) + (c) 2013, Hewlett-Packard Development Company, L.P. +License: Apache-2.0 + +License: Apache-2.0 + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + . + http://www.apache.org/licenses/LICENSE-2.0 + . + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + . + On Debian-based systems the full text of the Apache version 2.0 license + can be found in `/usr/share/common-licenses/Apache-2.0'. diff --git a/debian/gbp.conf b/debian/gbp.conf new file mode 100644 index 0000000..ccf8702 --- /dev/null +++ b/debian/gbp.conf @@ -0,0 +1,8 @@ +[DEFAULT] +upstream-branch = master +debian-branch = debian/unstable +upstream-tag = %(version)s +compression = xz + +[git-buildpackage] +export-dir = ../build-area/ diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..ea632e6 --- /dev/null +++ b/debian/rules @@ -0,0 +1,9 @@ +#!/usr/bin/make -f + +UPSTREAM_GIT = git://github.com/openstack/oslo.sphinx.git +include /usr/share/openstack-pkg-tools/pkgos.make + +export OSLO_PACKAGE_VERSION=$(VERSION) + +%: + dh $@ --with python2 diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/debian/watch b/debian/watch new file mode 100644 index 0000000..bc92532 --- /dev/null +++ b/debian/watch @@ -0,0 +1,2 @@ +version=3 +https://github.com/openstack/oslo.sphinx/tags .*/(\d[\d\.]+)\.tar\.gz -- GitLab From dbd45265c6d4e0b3f8e8eadf69aee6b91ecc76a3 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 25 Jul 2013 10:29:24 +0000 Subject: [PATCH 002/192] Added license for jquery.tweet.js --- debian/copyright | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/debian/copyright b/debian/copyright index cdaa4b8..c41ae5d 100644 --- a/debian/copyright +++ b/debian/copyright @@ -6,6 +6,10 @@ Files: debian/* Copyright: (c) 2013, Thomas Goirand License: Apache-2.0 +Files: oslo/sphinx/theme/openstack/static/jquery.tweet.js +Copyright: (c) 2008-2012 Todd Matthews & Steve Purcell +License: MIT + Files: * Copyright: (c) 2013, Monty Taylor (c) 2013, Doug Hellmann @@ -29,3 +33,23 @@ License: Apache-2.0 . On Debian-based systems the full text of the Apache version 2.0 license can be found in `/usr/share/common-licenses/Apache-2.0'. + +License: MIT + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + . + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + . + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- GitLab From 9f9a9c4bb4dcf31ab5f644646028b6d62c846701 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 25 Jul 2013 19:24:23 +0800 Subject: [PATCH 003/192] Cleans correctly. --- debian/changelog | 6 ++++++ debian/rules | 6 +++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 218fca1..ca584f5 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (1.0-2) unstable; urgency=low + + * Cleans correctly (package can be built twice). + + -- Thomas Goirand Thu, 25 Jul 2013 19:24:07 +0800 + oslo-sphinx (1.0-1) unstable; urgency=low * Initial release (Closes: #717809). diff --git a/debian/rules b/debian/rules index ea632e6..c85518b 100755 --- a/debian/rules +++ b/debian/rules @@ -6,4 +6,8 @@ include /usr/share/openstack-pkg-tools/pkgos.make export OSLO_PACKAGE_VERSION=$(VERSION) %: - dh $@ --with python2 + dh $@ --buildsystem=python_distutils --with python2 + +override_dh_clean: + dh_clean -O--buildsystem=python_distutils + rm -rf oslo.sphinx.egg-info -- GitLab From f371b60535e5cf2237276cb17a7135e89a2b8525 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 15:54:30 +0800 Subject: [PATCH 004/192] Now packaging upstream release 2.0 --- debian/changelog | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/debian/changelog b/debian/changelog index ca584f5..21dc9aa 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (2.0-1) experimental; urgency=medium + + * New upstream release. + + -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 + oslo-sphinx (1.0-2) unstable; urgency=low * Cleans correctly (package can be built twice). -- GitLab From 764ec5fcf30382a6ac5ce4c795d600b7fede9310 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 15:56:55 +0800 Subject: [PATCH 005/192] Now packaging oslosphinx --- debian/changelog | 3 +++ debian/control | 18 +++++++++++++++--- debian/gbp.conf | 2 +- debian/rules | 8 ++++++++ 4 files changed, 27 insertions(+), 4 deletions(-) diff --git a/debian/changelog b/debian/changelog index 21dc9aa..b57728e 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,6 +1,9 @@ oslo-sphinx (2.0-1) experimental; urgency=medium * New upstream release. + * Standards-Version: is now 3.9.5. + * Upstream renamed oslo.sphinx into oslosphinx, transitionning + accordingly (and adding a new package). -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 diff --git a/debian/control b/debian/control index 54bc151..2b5d822 100644 --- a/debian/control +++ b/debian/control @@ -10,15 +10,27 @@ Build-Depends: debhelper (>= 9), python-all (>= 2.6.6-3~), python-setuptools Build-Depends-Indep: python-d2to1, python-pbr -Standards-Version: 3.9.4 +Standards-Version: 3.9.5 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git Homepage: https://github.com/openstack/oslo.sphinx -Package: python-oslo.sphinx +Package: python-oslosphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~) Depends: ${misc:Depends}, ${python:Depends} Description: theme and extension support for openstack Theme and extension support for Sphinx documentation from the OpenStack - project. + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + +Package: python-oslo.sphinx +Architecture: all +Pre-Depends: dpkg (>= 1.15.6~) +Depends: ${misc:Depends}, ${python:Depends}, python-oslosphinx +Description: theme and extension support for openstack - transition package + Theme and extension support for Sphinx documentation from the OpenStack + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + . + This is a dummy transition package. diff --git a/debian/gbp.conf b/debian/gbp.conf index ccf8702..fe85503 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/unstable +debian-branch = debian/experimental upstream-tag = %(version)s compression = xz diff --git a/debian/rules b/debian/rules index c85518b..f0cca79 100755 --- a/debian/rules +++ b/debian/rules @@ -1,5 +1,7 @@ #!/usr/bin/make -f +PYTHONS:=$(shell pyversions -vr) + UPSTREAM_GIT = git://github.com/openstack/oslo.sphinx.git include /usr/share/openstack-pkg-tools/pkgos.make @@ -11,3 +13,9 @@ export OSLO_PACKAGE_VERSION=$(VERSION) override_dh_clean: dh_clean -O--buildsystem=python_distutils rm -rf oslo.sphinx.egg-info + +override_dh_auto_install: + set -e && for pyvers in $(PYTHONS); do \ + python$$pyvers setup.py install --install-layout=deb \ + --root $(CURDIR)/debian/python-oslosphinx; \ + done -- GitLab From 9cbf131b2a786a8e2e484a45360a3b98b96320f8 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 23:09:58 +0800 Subject: [PATCH 006/192] Removed oslo/sphinx/theme/openstack/static/jquery.tweet.js from debian/copyright, because the file is gone upstream. --- debian/changelog | 2 ++ debian/copyright | 24 ------------------------ 2 files changed, 2 insertions(+), 24 deletions(-) diff --git a/debian/changelog b/debian/changelog index b57728e..0a48e06 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,6 +4,8 @@ oslo-sphinx (2.0-1) experimental; urgency=medium * Standards-Version: is now 3.9.5. * Upstream renamed oslo.sphinx into oslosphinx, transitionning accordingly (and adding a new package). + * Removed oslo/sphinx/theme/openstack/static/jquery.tweet.js from + debian/copyright, because the file is gone upstream. -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 diff --git a/debian/copyright b/debian/copyright index c41ae5d..cdaa4b8 100644 --- a/debian/copyright +++ b/debian/copyright @@ -6,10 +6,6 @@ Files: debian/* Copyright: (c) 2013, Thomas Goirand License: Apache-2.0 -Files: oslo/sphinx/theme/openstack/static/jquery.tweet.js -Copyright: (c) 2008-2012 Todd Matthews & Steve Purcell -License: MIT - Files: * Copyright: (c) 2013, Monty Taylor (c) 2013, Doug Hellmann @@ -33,23 +29,3 @@ License: Apache-2.0 . On Debian-based systems the full text of the Apache version 2.0 license can be found in `/usr/share/common-licenses/Apache-2.0'. - -License: MIT - Permission is hereby granted, free of charge, to any person obtaining - a copy of this software and associated documentation files (the - "Software"), to deal in the Software without restriction, including - without limitation the rights to use, copy, modify, merge, publish, - distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to - the following conditions: - . - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - . - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- GitLab From 7228694bd7b21535cc352cf7ac53da6262c1d318 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Sun, 9 Mar 2014 14:09:53 +0800 Subject: [PATCH 007/192] Packages the oslosphinx/theme folder correctly. --- debian/changelog | 6 ++++++ debian/rules | 1 + 2 files changed, 7 insertions(+) diff --git a/debian/changelog b/debian/changelog index 0a48e06..d06944b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (2.0-2) experimental; urgency=medium + + * Packages the oslosphinx/theme folder correctly. + + -- Thomas Goirand Sun, 09 Mar 2014 14:09:12 +0800 + oslo-sphinx (2.0-1) experimental; urgency=medium * New upstream release. diff --git a/debian/rules b/debian/rules index f0cca79..fa05ec1 100755 --- a/debian/rules +++ b/debian/rules @@ -18,4 +18,5 @@ override_dh_auto_install: set -e && for pyvers in $(PYTHONS); do \ python$$pyvers setup.py install --install-layout=deb \ --root $(CURDIR)/debian/python-oslosphinx; \ + cp -rf oslosphinx/theme $(CURDIR)/debian/python-oslosphinx/usr/lib/python$$pyvers/dist-packages/oslosphinx ; \ done -- GitLab From 2b41997c8e6fefb89b45fbbb97b000458e46bed4 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Fri, 21 Mar 2014 05:58:32 +0000 Subject: [PATCH 008/192] Fixed copyright (includes nature.css copyright now). --- debian/changelog | 15 +++++++++++++++ debian/copyright | 29 +++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/debian/changelog b/debian/changelog index d06944b..1338015 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,10 @@ +oslo-sphinx (2.0-3) experimental; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license (this was previously fixed in Sid). + + -- Thomas Goirand Fri, 21 Mar 2014 05:56:11 +0000 + oslo-sphinx (2.0-2) experimental; urgency=medium * Packages the oslosphinx/theme folder correctly. @@ -15,6 +22,14 @@ oslo-sphinx (2.0-1) experimental; urgency=medium -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 +oslo-sphinx (1.0-3) unstable; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license. (Closes: #740932). + * Standards-Version: is now 3.9.5. + + -- Thomas Goirand Fri, 21 Mar 2014 05:49:08 +0000 + oslo-sphinx (1.0-2) unstable; urgency=low * Cleans correctly (package can be built twice). diff --git a/debian/copyright b/debian/copyright index cdaa4b8..d16cebb 100644 --- a/debian/copyright +++ b/debian/copyright @@ -6,6 +6,10 @@ Files: debian/* Copyright: (c) 2013, Thomas Goirand License: Apache-2.0 +Files: oslosphinx/theme/openstack/static/nature.css +Copyright: (c) 2007-2011 the Sphinx team +License: BSD-2-clause + Files: * Copyright: (c) 2013, Monty Taylor (c) 2013, Doug Hellmann @@ -29,3 +33,28 @@ License: Apache-2.0 . On Debian-based systems the full text of the Apache version 2.0 license can be found in `/usr/share/common-licenses/Apache-2.0'. + +License: BSD-2-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + . + Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + . + Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. Neither the name of + the University of California, Berkeley nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -- GitLab From 1e075ce77cf0766b63982fa0b89b2e7af8a0c707 Mon Sep 17 00:00:00 2001 From: gustavo panizzo Date: Wed, 2 Apr 2014 16:42:14 -0300 Subject: [PATCH 009/192] packaging for 2.1.0 --- debian/changelog | 6 ++++++ debian/control | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index ca584f5..1e442df 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (2.1.0-1) unstable; urgency=medium + + * New upstream release. + + -- gustavo panizzo Wed, 02 Apr 2014 16:38:06 -0300 + oslo-sphinx (1.0-2) unstable; urgency=low * Cleans correctly (package can be built twice). diff --git a/debian/control b/debian/control index 54bc151..91b7518 100644 --- a/debian/control +++ b/debian/control @@ -9,8 +9,8 @@ Build-Depends: debhelper (>= 9), openstack-pkg-tools, python-all (>= 2.6.6-3~), python-setuptools -Build-Depends-Indep: python-d2to1, python-pbr -Standards-Version: 3.9.4 +Build-Depends-Indep: python-d2to1, python-hacking, python-pbr +Standards-Version: 3.9.5 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git Homepage: https://github.com/openstack/oslo.sphinx -- GitLab From fa54c69fcda06d96577b439c2b23c4c021ed6b4e Mon Sep 17 00:00:00 2001 From: gustavo panizzo Date: Wed, 2 Apr 2014 16:45:22 -0300 Subject: [PATCH 010/192] Updated upstream changelog --- debian/CHANGELOG | 228 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 228 insertions(+) create mode 100644 debian/CHANGELOG diff --git a/debian/CHANGELOG b/debian/CHANGELOG new file mode 100644 index 0000000..92b85be --- /dev/null +++ b/debian/CHANGELOG @@ -0,0 +1,228 @@ +commit d32931265aa9cbc3401740119199c61715d2a15c +Author: Vishvananda Ishaya +Date: Tue Mar 18 11:22:06 2014 -0700 + + Update manifest to use oslosphinx + + The recent rename to oslosphinx missed the MANIFEST.in, which + breaks packaging of the non .py files. + + Change-Id: Ib43879697cb855341904500dae3075f7ea5c17c0 + Resolves-bug: 1294272 + +commit ba83cf44b514f65b85b199697f8668fe47ff1083 +Author: ChangBo Guo(gcb) +Date: Mon Feb 24 04:19:47 2014 -0500 + + Remove vim header + + We don't need vim modelines in each source file, it can be set in + user's vimrc. + + Change-Id: If4f0e93821e20ea837c1fc908845089dd192fcde + Closes-Bug: #1229324 + +commit 28f4cf00a061a96c14ec389f11aa3d919d94d040 +Author: Ben Nemec +Date: Wed Feb 12 16:40:51 2014 +0000 + + Remove references to oslo.sphinx + + There were a few left over in the documentation + + Change-Id: I87ca3e6c104798a94874916df355b6bdc74c1408 + +commit 54062b0b1deeab9e9339378f9450ff495e216b19 +Merge: e7a6344 b31e8f8 +Author: Jenkins +Date: Tue Feb 11 17:04:36 2014 +0000 + + Merge "Sync with global requirements" + +commit e7a6344754f04943acc050872150ab60907b365c +Author: Doug Hellmann +Date: Fri Feb 7 20:42:08 2014 +0000 + + Update .gitreview after repo rename + + Change-Id: I6b6e20a7884b47ade466fc38641a5ac1a5f3e146 + +commit 229e16bde97e7b3c7d9c0fd7a4a18c553ce94522 +Author: Doug Hellmann +Date: Thu Feb 6 08:42:54 2014 -0800 + + Rename package from oslo.sphinx to oslosphinx + + Having the sphinx theme in the same namespace package + as the production code has been causing issues with + devstack installations. This change renames the package + to move it out of the namespace. Another change to the + openstack-infra/config repository will rename the + git repository and associated jobs. + + Partial-bug: #1277168 + + Change-Id: I7788a9d6b5984fdfcc4678f2182104d2eb8a2be0 + +commit b31e8f8ca4527e124f9eb15c0a9266a672c6b0bf +Author: Sascha Peilicke +Date: Thu Jan 16 09:16:42 2014 +0100 + + Sync with global requirements + + Change-Id: I6667cf4e868abd4bc63d0d950f7a21c0b5e53f54 + +commit 0fd757d3ed10842a4cd34036a4ab6f983c3f6238 +Merge: 23e6cb4 a530d5e +Author: Jenkins +Date: Mon Dec 30 15:30:38 2013 +0000 + + Merge "Add -U flag to pip install command" + +commit a530d5ed8187fbc613c09fd44584f14c572fe217 +Author: Sergey Lukjanov +Date: Fri Dec 13 20:13:11 2013 +0400 + + Add -U flag to pip install command + + The -U flag makes tox able to upgrade all packages to the newest available + version. + + Change-Id: Ibe5fa0115c2b151ae6f3bd741cc561d2435499e8 + +commit 23e6cb4e11252a04a151b536f15c7a2fc089ec8f +Author: Joe Gordon +Date: Mon Nov 11 10:56:11 2013 -0800 + + Update URL for global HACKING document + + * Related to I579e7c889f3addc2cd40bce0c584bbc70bf435e2 + * Rename local-checks section to make it clearer + + Change-Id: If4e006368c09dcd6c87ebf7a2aba448c9a9390de + +commit 8e152992d4b634e8e346ee6271bf73f579807306 +Merge: d4b06ba 6a71811 +Author: Jenkins +Date: Fri Sep 20 15:27:24 2013 +0000 + + Merge "Update build config" + +commit 6a71811cd733224c7dfb0ed7c5c8f155cfe58976 +Author: Monty Taylor +Date: Thu Sep 19 07:36:45 2013 -0700 + + Update build config + + Use latest pbr things that don't require pbr. Also update the tox config + to ensure venv is updated properly. + + Change-Id: I157127abd129bbe085c64e2a14f67296da0c4b5e + +commit d4b06bab5659926ac8219f750361be4a5158420a +Author: Mark McLoughlin +Date: Wed Sep 18 07:48:56 2013 -0700 + + Add namespace_packages to setup.cfg + + We lost this when switching to latest pbr. + + Thanks to dprince for catching this in Smokestack. + + Change-Id: Ideb3f9750269d825f380351c3bbbbf743bff08ba + +commit c89928aaa02d6f84d2edabda246812f0976e6640 +Author: Monty Taylor +Date: Fri Sep 13 11:33:49 2013 -0500 + + Update pbr usage past needing d2to1 + + Change-Id: Ia5c8dd9259e8098c2ad39eda6fc44c6db81944ad + +commit f296853bedb92c3faded41790a05c203f41e9732 +Author: Julien Danjou +Date: Thu Jul 25 16:09:18 2013 +0200 + + Remove useless jquery.tweet.js + + This file exports a jQuery tweet function, but it's never called anywhere in + the theme. + + Change-Id: Ie5191940a8e9dc3e2562888d050cd00dc63066d8 + +commit 9f34799a2c9880fce18d3f89033caa968cfd7ad1 +Author: Sergey Lukjanov +Date: Sat Jul 20 00:48:36 2013 +0400 + + Allow use of hacking 0.6.0 and fix min version + + Change-Id: If336be59cf790029b5e24f05074e6ec6e9658134 + +commit e4b2587d6b7ae2faa8cb9da7039a82705fbb3067 +Author: Monty Taylor +Date: Fri Jul 5 11:06:22 2013 -0400 + + Add an OpenStack-wide intersphinx mapping file + + Change-Id: Id30470132eb9540b6f7fb693fca5ec0cbe2ce49a + +commit 9ab5dacf3efbf5c3900176484082edf2623ed638 +Merge: f93071e b139fa8 +Author: Jenkins +Date: Fri Jul 12 22:45:30 2013 +0000 + + Merge "Ensure that AUTHORS and ChangeLog are packaged" + +commit b139fa873e35fb4e60333f25b6e548d4a355becc +Author: Dirk Mueller +Date: Mon Jul 8 11:04:55 2013 +0200 + + Ensure that AUTHORS and ChangeLog are packaged + + Include AUTHORS and ChangeLog from pbr to be included + in the sdist tarball. Add a minimal HACKING.rst for + consistency with other projects. + + Fixes LP Bug #1186518 + + Change-Id: I0f188c1c1b449b74b43296222d33a89f98645950 + +commit f93071eef0039a570f887bbd2c46324ce75873ce +Author: Monty Taylor +Date: Fri Jul 5 11:15:52 2013 -0400 + + Add emacs save files to gitignore + + Change-Id: If0accbcc80d9289907d83a9df0e0d0604c11800b + +commit 4e2051a422307ee1a9c28cc221fa3ff82d025c0d +Author: Monty Taylor +Date: Fri Jul 5 13:04:22 2013 -0400 + + Add venv tox env. + + OpenStack CI requires this to generate the tarball. + + Change-Id: I170f4d25e4a59027d4c85ff70f03f31a1b3dc916 + +commit ac91ff16bc7e0ec7bd9157cef04aae5f5518663a +Author: Doug Hellmann +Date: Mon Jul 1 17:32:22 2013 -0400 + + Import Sphinx theme for OpenStack + + This is a copy of the Sphinx theme for OpenStack developer + documentation imported from the ceilometer repository. After + this library is released, we will remove the copies of the + theme from all of the other repositories. + + blueprint oslo.sphinx + + Change-Id: I20b6c224b8d8fbede354c2a28ad67eda3a4b9dac + Signed-off-by: Doug Hellmann + +commit eca47086d010f519bf7fb32e9c56c79e13c255c9 +Author: OpenStack Project Creator +Date: Sun Jun 30 17:07:29 2013 +0000 + + Added .gitreview -- GitLab From 8e5aedbea7eec4ac60c03bf16ba4cf19a7e936cc Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 15:54:30 +0800 Subject: [PATCH 011/192] Now packaging upstream release 2.0 --- debian/changelog | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/debian/changelog b/debian/changelog index 1e442df..229da12 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,6 +4,12 @@ oslo-sphinx (2.1.0-1) unstable; urgency=medium -- gustavo panizzo Wed, 02 Apr 2014 16:38:06 -0300 +oslo-sphinx (2.0-1) experimental; urgency=medium + + * New upstream release. + + -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 + oslo-sphinx (1.0-2) unstable; urgency=low * Cleans correctly (package can be built twice). -- GitLab From 5902d5c197271771c237cb74b8ce605db6b929ae Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 15:56:55 +0800 Subject: [PATCH 012/192] Now packaging oslosphinx --- debian/changelog | 3 +++ debian/control | 16 ++++++++++++++-- debian/gbp.conf | 2 +- debian/rules | 8 ++++++++ 4 files changed, 26 insertions(+), 3 deletions(-) diff --git a/debian/changelog b/debian/changelog index 229da12..5293b61 100644 --- a/debian/changelog +++ b/debian/changelog @@ -7,6 +7,9 @@ oslo-sphinx (2.1.0-1) unstable; urgency=medium oslo-sphinx (2.0-1) experimental; urgency=medium * New upstream release. + * Standards-Version: is now 3.9.5. + * Upstream renamed oslo.sphinx into oslosphinx, transitionning + accordingly (and adding a new package). -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 diff --git a/debian/control b/debian/control index 91b7518..4f66b8b 100644 --- a/debian/control +++ b/debian/control @@ -15,10 +15,22 @@ Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git Homepage: https://github.com/openstack/oslo.sphinx -Package: python-oslo.sphinx +Package: python-oslosphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~) Depends: ${misc:Depends}, ${python:Depends} Description: theme and extension support for openstack Theme and extension support for Sphinx documentation from the OpenStack - project. + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + +Package: python-oslo.sphinx +Architecture: all +Pre-Depends: dpkg (>= 1.15.6~) +Depends: ${misc:Depends}, ${python:Depends}, python-oslosphinx +Description: theme and extension support for openstack - transition package + Theme and extension support for Sphinx documentation from the OpenStack + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + . + This is a dummy transition package. diff --git a/debian/gbp.conf b/debian/gbp.conf index ccf8702..fe85503 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/unstable +debian-branch = debian/experimental upstream-tag = %(version)s compression = xz diff --git a/debian/rules b/debian/rules index c85518b..f0cca79 100755 --- a/debian/rules +++ b/debian/rules @@ -1,5 +1,7 @@ #!/usr/bin/make -f +PYTHONS:=$(shell pyversions -vr) + UPSTREAM_GIT = git://github.com/openstack/oslo.sphinx.git include /usr/share/openstack-pkg-tools/pkgos.make @@ -11,3 +13,9 @@ export OSLO_PACKAGE_VERSION=$(VERSION) override_dh_clean: dh_clean -O--buildsystem=python_distutils rm -rf oslo.sphinx.egg-info + +override_dh_auto_install: + set -e && for pyvers in $(PYTHONS); do \ + python$$pyvers setup.py install --install-layout=deb \ + --root $(CURDIR)/debian/python-oslosphinx; \ + done -- GitLab From f45dc798a0baef780230c938df5d9ca3bb809946 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 5 Mar 2014 23:09:58 +0800 Subject: [PATCH 013/192] Removed oslo/sphinx/theme/openstack/static/jquery.tweet.js from debian/copyright, because the file is gone upstream. --- debian/changelog | 2 ++ debian/copyright | 24 ------------------------ 2 files changed, 2 insertions(+), 24 deletions(-) diff --git a/debian/changelog b/debian/changelog index 5293b61..5dad008 100644 --- a/debian/changelog +++ b/debian/changelog @@ -10,6 +10,8 @@ oslo-sphinx (2.0-1) experimental; urgency=medium * Standards-Version: is now 3.9.5. * Upstream renamed oslo.sphinx into oslosphinx, transitionning accordingly (and adding a new package). + * Removed oslo/sphinx/theme/openstack/static/jquery.tweet.js from + debian/copyright, because the file is gone upstream. -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 diff --git a/debian/copyright b/debian/copyright index c41ae5d..cdaa4b8 100644 --- a/debian/copyright +++ b/debian/copyright @@ -6,10 +6,6 @@ Files: debian/* Copyright: (c) 2013, Thomas Goirand License: Apache-2.0 -Files: oslo/sphinx/theme/openstack/static/jquery.tweet.js -Copyright: (c) 2008-2012 Todd Matthews & Steve Purcell -License: MIT - Files: * Copyright: (c) 2013, Monty Taylor (c) 2013, Doug Hellmann @@ -33,23 +29,3 @@ License: Apache-2.0 . On Debian-based systems the full text of the Apache version 2.0 license can be found in `/usr/share/common-licenses/Apache-2.0'. - -License: MIT - Permission is hereby granted, free of charge, to any person obtaining - a copy of this software and associated documentation files (the - "Software"), to deal in the Software without restriction, including - without limitation the rights to use, copy, modify, merge, publish, - distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to - the following conditions: - . - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - . - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- GitLab From 941d40075032ef1df7eff39438590bb7d0a223de Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Sun, 9 Mar 2014 14:09:53 +0800 Subject: [PATCH 014/192] Packages the oslosphinx/theme folder correctly. --- debian/changelog | 6 ++++++ debian/rules | 1 + 2 files changed, 7 insertions(+) diff --git a/debian/changelog b/debian/changelog index 5dad008..2fdc37b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,6 +4,12 @@ oslo-sphinx (2.1.0-1) unstable; urgency=medium -- gustavo panizzo Wed, 02 Apr 2014 16:38:06 -0300 +oslo-sphinx (2.0-2) experimental; urgency=medium + + * Packages the oslosphinx/theme folder correctly. + + -- Thomas Goirand Sun, 09 Mar 2014 14:09:12 +0800 + oslo-sphinx (2.0-1) experimental; urgency=medium * New upstream release. diff --git a/debian/rules b/debian/rules index f0cca79..fa05ec1 100755 --- a/debian/rules +++ b/debian/rules @@ -18,4 +18,5 @@ override_dh_auto_install: set -e && for pyvers in $(PYTHONS); do \ python$$pyvers setup.py install --install-layout=deb \ --root $(CURDIR)/debian/python-oslosphinx; \ + cp -rf oslosphinx/theme $(CURDIR)/debian/python-oslosphinx/usr/lib/python$$pyvers/dist-packages/oslosphinx ; \ done -- GitLab From f6d79be208366d89b3f3ca2daf7923aa4762c164 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Fri, 21 Mar 2014 05:58:32 +0000 Subject: [PATCH 015/192] Fixed copyright (includes nature.css copyright now). --- debian/changelog | 15 +++++++++++++++ debian/copyright | 29 +++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/debian/changelog b/debian/changelog index 2fdc37b..f5fe832 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,6 +4,13 @@ oslo-sphinx (2.1.0-1) unstable; urgency=medium -- gustavo panizzo Wed, 02 Apr 2014 16:38:06 -0300 +oslo-sphinx (2.0-3) experimental; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license (this was previously fixed in Sid). + + -- Thomas Goirand Fri, 21 Mar 2014 05:56:11 +0000 + oslo-sphinx (2.0-2) experimental; urgency=medium * Packages the oslosphinx/theme folder correctly. @@ -21,6 +28,14 @@ oslo-sphinx (2.0-1) experimental; urgency=medium -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 +oslo-sphinx (1.0-3) unstable; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license. (Closes: #740932). + * Standards-Version: is now 3.9.5. + + -- Thomas Goirand Fri, 21 Mar 2014 05:49:08 +0000 + oslo-sphinx (1.0-2) unstable; urgency=low * Cleans correctly (package can be built twice). diff --git a/debian/copyright b/debian/copyright index cdaa4b8..d16cebb 100644 --- a/debian/copyright +++ b/debian/copyright @@ -6,6 +6,10 @@ Files: debian/* Copyright: (c) 2013, Thomas Goirand License: Apache-2.0 +Files: oslosphinx/theme/openstack/static/nature.css +Copyright: (c) 2007-2011 the Sphinx team +License: BSD-2-clause + Files: * Copyright: (c) 2013, Monty Taylor (c) 2013, Doug Hellmann @@ -29,3 +33,28 @@ License: Apache-2.0 . On Debian-based systems the full text of the Apache version 2.0 license can be found in `/usr/share/common-licenses/Apache-2.0'. + +License: BSD-2-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + . + Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + . + Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. Neither the name of + the University of California, Berkeley nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -- GitLab From 7036920f6278141ea969ac6755ceff2fedc1f809 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Fri, 18 Apr 2014 10:26:16 +0800 Subject: [PATCH 016/192] Uploading to unstable. --- debian/gbp.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debian/gbp.conf b/debian/gbp.conf index fe85503..ccf8702 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/experimental +debian-branch = debian/unstable upstream-tag = %(version)s compression = xz -- GitLab From a73585a13846cff556c99d50ba9a721f71e403da Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Fri, 18 Apr 2014 10:34:03 +0800 Subject: [PATCH 017/192] Uploading to unstable. --- debian/changelog | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index f5fe832..f7b2b21 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,8 +1,12 @@ oslo-sphinx (2.1.0-1) unstable; urgency=medium + [ Thomas Goirand ] + * Uploading to unstable. + + [ gustavo panizzo ] * New upstream release. - -- gustavo panizzo Wed, 02 Apr 2014 16:38:06 -0300 + -- Thomas Goirand Fri, 18 Apr 2014 10:33:19 +0800 oslo-sphinx (2.0-3) experimental; urgency=medium -- GitLab From f6fee8b01f20791ce18a090c2b8e23d323ee23be Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 3 Sep 2014 14:34:48 -0400 Subject: [PATCH 018/192] warn against sorting requirements Change-Id: I64ae9191863564e278a35d42ec9cd743a233028e Addresses-Bug: #1365061 --- test-requirements.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/test-requirements.txt b/test-requirements.txt index c0de34d..25d6fae 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1 +1,5 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + hacking>=0.9.2,<0.10 -- GitLab From 85c9e98318ef0e1c2187f2ed30b8b1a17ed69b33 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Fri, 5 Sep 2014 15:07:26 +0800 Subject: [PATCH 019/192] Now packaging upstream release 2.2.0.0~a3 --- debian/changelog | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/debian/changelog b/debian/changelog index f7b2b21..291a9a7 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,10 @@ +oslo-sphinx (2.2.0.0~a3-1) experimental; urgency=medium + + * New upstream release. + * Uploading to experimental before the freeze of Jessie. + + -- Thomas Goirand Fri, 05 Sep 2014 15:06:42 +0800 + oslo-sphinx (2.1.0-1) unstable; urgency=medium [ Thomas Goirand ] -- GitLab From 846487072c5e66b7aea615bd8efdb849409eb1c9 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Thu, 11 Sep 2014 10:37:00 +0200 Subject: [PATCH 020/192] Remove empty file It's useless to include it since it's empty. Change-Id: I18e147ed2a62671ece9228eb3c6c411bb2aea8f7 --- requirements.txt | 0 tox.ini | 3 +-- 2 files changed, 1 insertion(+), 2 deletions(-) delete mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index e69de29..0000000 diff --git a/tox.ini b/tox.ini index e7a71d7..db0b44a 100644 --- a/tox.ini +++ b/tox.ini @@ -6,8 +6,7 @@ envlist = pep8 [testenv] usedevelop = True install_command = pip install -U {opts} {packages} -deps = -r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt +deps = -r{toxinidir}/test-requirements.txt setenv = VIRTUAL_ENV={envdir} sitepackages = False downloadcache = {toxworkdir}/_download -- GitLab From 446a8dc6ca827fe5e9c17f24ea7326338d10d9d6 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Wed, 3 Sep 2014 15:51:48 -0400 Subject: [PATCH 021/192] Add initial cut for documentation Closes-Bug: #1364141 Change-Id: I137d244a50088918e2356da883d09f5d95da8bca --- CONTRIBUTING.rst | 17 +++++++++ doc/source/conf.py | 75 +++++++++++++++++++++++++++++++++++++ doc/source/contributing.rst | 4 ++ doc/source/index.rst | 24 ++++++++++++ doc/source/installation.rst | 7 ++++ doc/source/readme.rst | 1 + doc/source/usage.rst | 7 ++++ test-requirements.txt | 3 ++ tox.ini | 4 +- 9 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.rst create mode 100755 doc/source/conf.py create mode 100644 doc/source/contributing.rst create mode 100644 doc/source/index.rst create mode 100644 doc/source/installation.rst create mode 100644 doc/source/readme.rst create mode 100644 doc/source/usage.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..35251f0 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,17 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/oslosphinx diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..8b66547 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', + #'sphinx.ext.intersphinx', + 'oslosphinx' +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'oslosphinx' +copyright = u'2013, OpenStack Foundation' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..ed77c12 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,4 @@ +============ +Contributing +============ +.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..27475a8 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,24 @@ +.. oslosphinx documentation master file, created by + sphinx-quickstart on Tue Jul 9 22:26:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +oslosphinx +========== + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + contributing + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..8b0a364 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,7 @@ +============ +Installation +============ + +At the command line:: + + $ pip install oslosphinx diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..38ba804 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst \ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..63fb002 --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use oslosphinx in a project:: + + import oslosphinx \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index 25d6fae..735907f 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,3 +3,6 @@ # process, which may cause wedges in the gate later. hacking>=0.9.2,<0.10 + +# this is required for the docs build jobs +sphinx>=1.1.2,!=1.2.0,<1.3 diff --git a/tox.ini b/tox.ini index db0b44a..16a6e89 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,5 @@ [tox] minversion = 1.6 -skipsdist = True envlist = pep8 [testenv] @@ -18,6 +17,9 @@ commands = [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools show-source = True -- GitLab From cf85e067d6b7302555b1b6009e2ac4aa82c0fae5 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 19 Sep 2014 11:32:56 -0400 Subject: [PATCH 022/192] Report documentation build warnings as errors Change-Id: Ib96d7e0353762e7296292739cd784f8e10d24ce2 --- setup.cfg | 3 +++ 1 file changed, 3 insertions(+) diff --git a/setup.cfg b/setup.cfg index b65ee52..a641fc3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,3 +35,6 @@ source-dir = doc/source [wheel] universal = 1 + +[pbr] +warnerrors = True -- GitLab From a0614823c5ea0ea7db17da7b9fc012d879077b26 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 24 Sep 2014 09:47:53 +0800 Subject: [PATCH 023/192] New upstream release. --- debian/changelog | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/debian/changelog b/debian/changelog index 291a9a7..cd03ee4 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (2.2.0.0-1) experimental; urgency=medium + + * New upstream release. + + -- Thomas Goirand Wed, 24 Sep 2014 09:47:25 +0800 + oslo-sphinx (2.2.0.0~a3-1) experimental; urgency=medium * New upstream release. -- GitLab From acd90677ef1ac0583cf4fe457236ff6e7d575845 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 21 Oct 2014 14:56:34 -0400 Subject: [PATCH 024/192] Tighten up documentation Remove some mostly empty pages and add a few section headings. Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fc --- README.rst | 10 ++++------ doc/source/contributing.rst | 9 +++++---- doc/source/index.rst | 14 +++----------- doc/source/installation.rst | 7 ------- doc/source/readme.rst | 1 - doc/source/usage.rst | 18 +++++++++++++----- 6 files changed, 25 insertions(+), 34 deletions(-) delete mode 100644 doc/source/installation.rst delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index 8fbf921..7e7e09d 100644 --- a/README.rst +++ b/README.rst @@ -4,9 +4,7 @@ OpenStack Sphinx Extensions Theme and extension support for Sphinx documentation from the OpenStack project. -To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in -the ``conf.py`` file in your Sphinx project. - -If you are an incubating project, set: - -``html_theme_options = {'incubating': True}`` in your conf.py as well, to enable the Incubation theme. +* Free software: Apache license +* Documentation: http://docs.openstack.org/developer/oslosphinx +* Source: http://git.openstack.org/cgit/openstack/oslosphinx +* Bugs: https://bugs.launchpad.net/oslosphinx diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index ed77c12..2ca75d1 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,4 +1,5 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file +============== + Contributing +============== + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 27475a8..24f424d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,18 +1,10 @@ -.. oslosphinx documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -oslosphinx -========== - -Contents: +============ + oslosphinx +============ .. toctree:: :maxdepth: 2 - readme - installation usage contributing diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index 8b0a364..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,7 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install oslosphinx diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst \ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 63fb002..61c8fbd 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,15 @@ -======== -Usage -======== +================== + Using oslosphinx +================== -To use oslosphinx in a project:: +To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in +the ``conf.py`` file in your Sphinx project. - import oslosphinx \ No newline at end of file +Incubating Projects +=================== + +If you are an incubating project, set:: + + html_theme_options = {'incubating': True} + +in your conf.py as well, to enable the Incubation theme. -- GitLab From 64fe08f93121dae6ba1d62aadf734fd8dc53f8cf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 24 Oct 2014 09:32:21 -0400 Subject: [PATCH 025/192] Add pbr to installation requirements Add pbr to the list of installation requirements so that it is installed via pip before this library is installed, instead of with easy_install. This avoids issues like Bug #1384919, and ensures that projects that use this library as a dependency are properly installed. Change-Id: I6c155370dbd01fe4748d5137bdf288e8d3e1a67e --- requirements.txt | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c81bd8e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +pbr>=0.6,!=0.7,<1.0 -- GitLab From 6ce23c5983ca552083a6963b8c698bb82ad0d504 Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Sat, 11 Oct 2014 15:56:21 +0000 Subject: [PATCH 026/192] Updated from global requirements Change-Id: Ie3c6bc00b6e3a13cf5f2ac0e68aa25fb8204375d --- test-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-requirements.txt b/test-requirements.txt index 735907f..b859e83 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,4 +5,4 @@ hacking>=0.9.2,<0.10 # this is required for the docs build jobs -sphinx>=1.1.2,!=1.2.0,<1.3 +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 -- GitLab From c7e307e35917fabd4990894c765d8f08b7da5296 Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Mon, 17 Nov 2014 08:36:30 -0500 Subject: [PATCH 027/192] provide visual separation in sidebar Enhance the sidebar display to provide visual distinction between top level items and lower level items. Top level items are now given a space above them so they are visually clumped with their children, and separated from each other. They are also emboldened for greater visual distinction. Ideally sphinx would actually tag li items with their depth as a class tag, but as it currently doesn't do that we can work around it with setting at ul li, and unsetting at ul li ul li. Change-Id: I88d4317ec69fe7fd6f5c2198f89de624f0d093da --- oslosphinx/theme/openstack/static/tweaks.css | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/oslosphinx/theme/openstack/static/tweaks.css b/oslosphinx/theme/openstack/static/tweaks.css index 6d3bea3..9b3a6ce 100644 --- a/oslosphinx/theme/openstack/static/tweaks.css +++ b/oslosphinx/theme/openstack/static/tweaks.css @@ -101,4 +101,15 @@ div.sphinxsidebar h3.highlighted { div.sphinxsidebar h3.highlighted a { color: #EEE; -} \ No newline at end of file +} + +/** provide visual separation for sidebar for increased readability. */ +div.sphinxsidebar ul li { + margin-top: 1em; + font-weight: bold; +} + +div.sphinxsidebar ul li ul li { + margin-top: 0; + font-weight: normal; +} -- GitLab From 879cbc5e9a0683941cfe32c7aaa5940bcbeecfd3 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Fri, 5 Dec 2014 03:30:39 +0000 Subject: [PATCH 028/192] Workflow documentation is now in infra-manual Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I5215be3250a2b88a46258d55d5aab611a4091113 --- CONTRIBUTING.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 35251f0..29a43ac 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,14 +1,13 @@ If you would like to contribute to the development of OpenStack, -you must follow the steps in the "If you're a developer, start here" -section of this page: +you must follow the steps in this page: - http://wiki.openstack.org/HowToContribute + http://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - http://wiki.openstack.org/GerritWorkflow + http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. -- GitLab From 4ce81f85fbee729a443d5c6e2f20fb328f18a9db Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 9 Dec 2014 09:55:54 -0500 Subject: [PATCH 029/192] Add an extension for validating blueprint names This new extension requires spec filenames to match blueprint names in the relevant project. This is based on work originally done in oslo-specs under https://review.openstack.org/#/c/138392/ Change-Id: Ifd58f4f71f661229f09ecf01047bc7a7b1dc0b08 --- doc/source/check_blueprints.rst | 48 ++++++++++++++ doc/source/index.rst | 1 + doc/source/usage.rst | 6 +- oslosphinx/check_blueprints.py | 110 ++++++++++++++++++++++++++++++++ requirements.txt | 1 + 5 files changed, 163 insertions(+), 3 deletions(-) create mode 100644 doc/source/check_blueprints.rst create mode 100644 oslosphinx/check_blueprints.py diff --git a/doc/source/check_blueprints.rst b/doc/source/check_blueprints.rst new file mode 100644 index 0000000..1d3ed2a --- /dev/null +++ b/doc/source/check_blueprints.rst @@ -0,0 +1,48 @@ +=========================================================== + Using oslosphinx.check_blueprints with Specs Repositories +=========================================================== + +The ``oslosphinx.check_blueprints`` extension verifies that the +filenames in spec repositories match a blueprint under a given +launchpad project. + +Enabling +======== + +Add ``'oslosphinx.check_blueprints'`` to the ``extensions`` list in +the ``conf.py`` file in your Sphinx project. + +Specifying the Launchpad Project +================================ + +Most projects should set ``check_blueprints_project`` to the name of +their launchpad project. This limits the search to the single project +named. + +:: + + check_blueprints_project = 'nova' + +Projects with multiple launchpad projects under their own project +group (such as Oslo), should instead set +``check_blueprints_project_group``. All projects in the group will be +scanned for each spec/blueprint name. + +:: + + check_blueprints_project_group = 'oslo' + +Checking Only the Current Release +================================= + +By default, all files under ``specs/`` are checked. For large specs +repositories, this can take a long time. To limit the checks to a +subdirectory for the current release, set +``check_blueprints_release``. + +For example:: + + check_blueprints_release = 'kilo' + +will cause files under ``specs/kilo`` to be checked, and other files +to be ignored. diff --git a/doc/source/index.rst b/doc/source/index.rst index 24f424d..6481815 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,6 +6,7 @@ :maxdepth: 2 usage + check_blueprints contributing Indices and tables diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 61c8fbd..a291a3c 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,6 +1,6 @@ -================== - Using oslosphinx -================== +============================ + Using the oslosphinx Theme +============================ To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in the ``conf.py`` file in your Sphinx project. diff --git a/oslosphinx/check_blueprints.py b/oslosphinx/check_blueprints.py new file mode 100644 index 0000000..56fb86d --- /dev/null +++ b/oslosphinx/check_blueprints.py @@ -0,0 +1,110 @@ +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +"""Ensure that the name of the spec file matches the name of a blueprint. +""" + +import requests + + +class BlueprintChecker(object): + + def __init__(self, app): + self.app = app + self.project_names = [] + self._good_bps = set() + self._prefix = None + self._warn_search = 'unset' + + BP_URL_TEMPLATE = 'https://api.launchpad.net/devel/%s/+spec/%s' + PROJ_LIST_URL_TEMPLATE = 'https://api.launchpad.net/1.0/%s/projects' + + def _load_project_settings(self): + if self.project_names: + return + # If a project_name is set in the configuration, use + # that. Otherwise, allow any project in the project group. + project_name = self.app.config.check_blueprints_project + pg_name = self.app.config.check_blueprints_project_group + if project_name: + self.project_names = [project_name] + self._warn_search = 'the %s project' % project_name + else: + proj_list_response = requests.get(self.PROJ_LIST_URL_TEMPLATE + % pg_name) + projects = proj_list_response.json()['entries'] + self.project_names = [p['name'] for p in projects] + self._warn_search = ('any projects in the %s project group' + % pg_name) + + @property + def desired_prefix(self): + """Determine the prefix for files we care to check. + + We only care about blueprints in the current release, if the + check_blueprints_release option is set. + + """ + if self._prefix is None: + release = self.app.config.check_blueprints_release + if release: + self._prefix = 'specs/%s/' % release + else: + self._prefix = 'specs/' + return self._prefix + + def doctree_resolved(self, app, doctree, docname): + """Hook registered as event handler.""" + if not docname.startswith(self.desired_prefix): + return + bp_name = docname.split('/')[-1] + if bp_name == 'index': + return + self.check(bp_name) + + def blueprint_exists(self, project_name, bp_name): + """Return boolean indicating whether the blueprint exists.""" + url = self.BP_URL_TEMPLATE % (project_name, bp_name) + response = requests.get(url) + return response.status_code == 200 + + def check(self, bp_name): + """Given one blueprint name, check to see if it is valid.""" + if bp_name in self._good_bps: + return True + self._load_project_settings() + self.app.info('') # emit newline + for project_name in self.project_names: + self.app.info('Checking for %s in %s' % (bp_name, project_name)) + if self.blueprint_exists(project_name, bp_name): + self.app.info('Found %s in %s' % (bp_name, project_name)) + self._good_bps.add(bp_name) + break + else: + self.app.warn( + 'Could not find a blueprint called %r in %s' + % (bp_name, self._warn_search), + location=(bp_name, 0), + ) + raise ValueError( + 'Document %s does not match any blueprint name in %s' + % (bp_name, self._warn_search)) + + +def setup(app): + app.info('Initializing %s' % __name__) + checker = BlueprintChecker(app) + app.connect('doctree-resolved', checker.doctree_resolved) + app.add_config_value('check_blueprints_project_group', 'openstack', 'env') + app.add_config_value('check_blueprints_project', '', 'env') + app.add_config_value('check_blueprints_release', '', 'env') diff --git a/requirements.txt b/requirements.txt index c81bd8e..19d3ae5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ # process, which may cause wedges in the gate later. pbr>=0.6,!=0.7,<1.0 +requests>=2.2.0,!=2.4.0 -- GitLab From 72750165445f4c39e2b830c82daadf1d3fa2786a Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 9 Dec 2014 10:06:48 -0500 Subject: [PATCH 030/192] Add run_cross_tests.sh from incubator Import run_cross_tests.sh from the incubator to make it easier to test the theme and other extensions against existing repositories. Change-Id: Ic36c8950d7cdafcfe74f88ed7dde00f98534b2af --- .gitignore | 1 + openstack-common.conf | 7 ++++ tools/run_cross_tests.sh | 91 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 99 insertions(+) create mode 100644 openstack-common.conf create mode 100755 tools/run_cross_tests.sh diff --git a/.gitignore b/.gitignore index 54989fa..ae9850e 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ doc/source/api/tests.*.rst doc/source/api/autoindex.rst doc/source/sourcecode *.mo +.update-venv diff --git a/openstack-common.conf b/openstack-common.conf new file mode 100644 index 0000000..2bae3b4 --- /dev/null +++ b/openstack-common.conf @@ -0,0 +1,7 @@ +[DEFAULT] + +# The list of modules to copy from oslo-incubator.git +script = tools/run_cross_tests.sh + +# The base module to hold the copy of openstack.common +base=oslosphinx diff --git a/tools/run_cross_tests.sh b/tools/run_cross_tests.sh new file mode 100755 index 0000000..5e7bc11 --- /dev/null +++ b/tools/run_cross_tests.sh @@ -0,0 +1,91 @@ +#!/bin/bash +# +# Run cross-project tests +# +# Usage: +# +# run_cross_tests.sh project_dir venv + +# Fail the build if any command fails +set -e + +project_dir="$1" +venv="$2" + +if [ -z "$project_dir" -o -z "$venv" ] +then + cat - < ./subunit_log.txt + fi + .tox/$venv/bin/python /usr/local/jenkins/slave_scripts/subunit2html.py ./subunit_log.txt testr_results.html + gzip -9 ./subunit_log.txt + gzip -9 ./testr_results.html + + export PYTHON=.tox/$venv/bin/python + set -e + rancount=$(.tox/$venv/bin/testr last | sed -ne 's/Ran \([0-9]\+\).*tests in.*/\1/p') + if [ "$rancount" -eq "0" ] ; then + echo + echo "Zero tests were run. At least one test should have been run." + echo "Failing this test as a result" + echo + exit 1 + fi +fi + +# If we make it this far, report status based on the tests that were +# run. +exit $result -- GitLab From c01c2265383fab6414d715cbb08ae8b294b1921c Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 2 Dec 2014 11:32:10 -0500 Subject: [PATCH 031/192] Add links to the README Add a few links to resources for the project so humans can find them but also so the release notes script will find them. Change-Id: If5fb9387e9ffb5c9288632beaa1b6d4e90d48033 --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7e7e09d..16b5b96 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ OpenStack Sphinx Extensions Theme and extension support for Sphinx documentation from the OpenStack project. -* Free software: Apache license +* Free software: Apache License, Version 2.0 * Documentation: http://docs.openstack.org/developer/oslosphinx * Source: http://git.openstack.org/cgit/openstack/oslosphinx -* Bugs: https://bugs.launchpad.net/oslosphinx +* Bugs: http://bugs.launchpad.net/oslosphinx -- GitLab From ccf8e1a8a957100164e7bbc72f5861b028c009a9 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 20 Jan 2015 13:18:54 -0500 Subject: [PATCH 032/192] Update run_cross_tests.sh to latest Change-Id: I0f660fde6bae0cc5a4aa1b7deb9f94d3ffee0bc5 --- tools/run_cross_tests.sh | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/tools/run_cross_tests.sh b/tools/run_cross_tests.sh index 5e7bc11..d61ae9d 100755 --- a/tools/run_cross_tests.sh +++ b/tools/run_cross_tests.sh @@ -10,7 +10,10 @@ set -e project_dir="$1" -venv="$2" +shift +venv="$1" +shift +posargs="$*" if [ -z "$project_dir" -o -z "$venv" ] then @@ -19,11 +22,12 @@ ERROR: Missing argument(s) Usage: - $0 PROJECT_DIR VIRTUAL_ENV + $0 PROJECT_DIR VIRTUAL_ENV [POSARGS] Example, run the python 2.7 tests for python-neutronclient: $0 /opt/stack/python-neutronclient py27 + $0 /opt/stack/nova py27 xenapi EOF exit 1 @@ -36,18 +40,23 @@ tox_envbin=$project_dir/.tox/$venv/bin our_name=$(python setup.py --name) +# Build the egg-info, including the source file list, +# so we install all of the files, even if the package +# list or name has changed. +python setup.py egg_info + # Replace the pip-installed package with the version in our source # tree. Look to see if we are already installed before trying to # uninstall ourselves, to avoid failures from packages that do not use us # yet. if $tox_envbin/pip freeze | grep -q $our_name then - $tox_envbin/pip uninstall -y $our_name + $tox_envbin/pip uninstall -y $our_name || echo "Ignoring error" fi $tox_envbin/pip install -U . # Run the tests -(cd $project_dir && tox -e $venv) +(cd $project_dir && tox -e $venv -- $posargs) result=$? -- GitLab From 7c282dc14a0c7a718a2f477e958822e4cf186d2a Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 26 Jan 2015 17:10:43 -0500 Subject: [PATCH 033/192] Allow alternate OpenStack themes By default oslosphinx forces projects that use it to use the theme contained in the package. The documentation team wants to provide a separate theme for some parts of the docs.openstack.org site. They are going to distribute it in their own package, but do still want to be able to use other features of oslosphinx. This change allows any name that starts "openstack" to be used, while retaining the default behavior of inserting the "openstack" theme if a project is using a different default or has not set a theme. Change-Id: I7a2c5a5c3805685b8fa0baaa47393d5fec312f30 --- oslosphinx/__init__.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index 08224b4..4a238c0 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -19,14 +19,16 @@ def builder_inited(app): theme_dir = os.path.join(os.path.dirname(__file__), 'theme') app.info('Using openstack theme from %s' % theme_dir) # Insert our theme directory at the front of the search path and - # force the theme setting to use the one in the package. This is - # done here, instead of in setup(), because conf.py is read after - # setup() runs, so if the conf contains these values the user - # values overwrite these. That's not bad for the theme, but it - # breaks the search path. + # force the theme setting to use the one in the package unless + # another openstack theme is already selected. This is done here, + # instead of in setup(), because conf.py is read after setup() + # runs, so if the conf contains these values the user values + # overwrite these. That's not bad for the theme, but it breaks the + # search path. app.config.html_theme_path.insert(0, theme_dir) # Set the theme name - app.config.html_theme = 'openstack' + if not app.config.html_theme.startswith('openstack'): + app.config.html_theme = 'openstack' # Re-initialize the builder, if it has the method for setting up # the templates and theme. if hasattr(app.builder, 'init_templates'): -- GitLab From e1b0dca451f2a492f5761950077eb6e721b64f60 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 24 Feb 2015 18:52:53 -0500 Subject: [PATCH 034/192] Speed up blueprint checking with naming convention If the blueprint file is named beginning with the name of a project, look there for the blueprint first. Change-Id: I49cf48ed001945670ab900fcc76cd4c2087ddbb7 --- oslosphinx/check_blueprints.py | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/oslosphinx/check_blueprints.py b/oslosphinx/check_blueprints.py index 56fb86d..e241edc 100644 --- a/oslosphinx/check_blueprints.py +++ b/oslosphinx/check_blueprints.py @@ -74,9 +74,13 @@ class BlueprintChecker(object): def blueprint_exists(self, project_name, bp_name): """Return boolean indicating whether the blueprint exists.""" + self.app.info('Checking for %s in %s' % (bp_name, project_name)) url = self.BP_URL_TEMPLATE % (project_name, bp_name) response = requests.get(url) - return response.status_code == 200 + if response.status_code == 200: + self.app.info('Found %s in %s' % (bp_name, project_name)) + return True + return False def check(self, bp_name): """Given one blueprint name, check to see if it is valid.""" @@ -84,10 +88,26 @@ class BlueprintChecker(object): return True self._load_project_settings() self.app.info('') # emit newline + candidate_project, dash, bp_name_to_find = bp_name.partition('-') + if candidate_project in self.project_names: + # First check the shortened name of the blueprint in the project. + if self.blueprint_exists(candidate_project, bp_name_to_find): + return + # Then check the full name of the blueprint in the project. + if self.blueprint_exists(candidate_project, bp_name): + return + self.app.info( + ('Blueprint name %r looks like it starts with a project ' + 'name, but %r was not found in project %r') % + (bp_name, bp_name_to_find, candidate_project) + ) + else: + self.app.info( + 'Blueprint checking is faster if the file names ' + 'start with the launchpad project name.' + ) for project_name in self.project_names: - self.app.info('Checking for %s in %s' % (bp_name, project_name)) if self.blueprint_exists(project_name, bp_name): - self.app.info('Found %s in %s' % (bp_name, project_name)) self._good_bps.add(bp_name) break else: -- GitLab From 7a62c57f87b4475ea8e086afbdd7bb9d6709148c Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 25 Feb 2015 10:23:56 +0100 Subject: [PATCH 035/192] Added python-pbr and python-requests as new depends. --- debian/changelog | 7 +++++++ debian/control | 14 ++++++++------ 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/debian/changelog b/debian/changelog index cd03ee4..53a16b6 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,10 @@ +oslo-sphinx (2.4.0-1) UNRELEASED; urgency=medium + + * New upstream release. + * Added python-pbr and python-requests as new Depends. + + -- Thomas Goirand Wed, 25 Feb 2015 10:20:53 +0100 + oslo-sphinx (2.2.0.0-1) experimental; urgency=medium * New upstream release. diff --git a/debian/control b/debian/control index 4f66b8b..3bb02f1 100644 --- a/debian/control +++ b/debian/control @@ -2,14 +2,13 @@ Source: oslo-sphinx Section: python Priority: optional Maintainer: PKG OpenStack -Uploaders: Julien Danjou , - Thomas Goirand , - Mehdi Abaakouk +Uploaders: Thomas Goirand Build-Depends: debhelper (>= 9), openstack-pkg-tools, python-all (>= 2.6.6-3~), + python-pbr, python-setuptools -Build-Depends-Indep: python-d2to1, python-hacking, python-pbr +Build-Depends-Indep: python-d2to1, python-hacking, python-requests (>= 2.2.0) Standards-Version: 3.9.5 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git @@ -18,7 +17,10 @@ Homepage: https://github.com/openstack/oslo.sphinx Package: python-oslosphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~) -Depends: ${misc:Depends}, ${python:Depends} +Depends: python-pbr (>= 0.6), + python-requests (>= 2.2.0), + ${misc:Depends}, + ${python:Depends} Description: theme and extension support for openstack Theme and extension support for Sphinx documentation from the OpenStack project. To use the theme, symply add 'oslosphinx' to the extensions list in @@ -27,7 +29,7 @@ Description: theme and extension support for openstack Package: python-oslo.sphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~) -Depends: ${misc:Depends}, ${python:Depends}, python-oslosphinx +Depends: python-oslosphinx, ${misc:Depends}, ${python:Depends} Description: theme and extension support for openstack - transition package Theme and extension support for Sphinx documentation from the OpenStack project. To use the theme, symply add 'oslosphinx' to the extensions list in -- GitLab From 6ddf76eecfea3184c215def2fcd6ba95c37f4fe5 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Wed, 25 Feb 2015 10:24:36 +0100 Subject: [PATCH 036/192] Using debian/kilo as packaging branch. --- debian/gbp.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debian/gbp.conf b/debian/gbp.conf index fe85503..a281224 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/experimental +debian-branch = debian/kilo upstream-tag = %(version)s compression = xz -- GitLab From 35a6151d74f46d0128a028041ddf1598fba4916c Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 2 Apr 2015 17:19:41 +0200 Subject: [PATCH 037/192] Now packaging 2.5.0 --- debian/changelog | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 53a16b6..6296b1f 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -oslo-sphinx (2.4.0-1) UNRELEASED; urgency=medium +oslo-sphinx (2.5.0-1) UNRELEASED; urgency=medium * New upstream release. * Added python-pbr and python-requests as new Depends. -- GitLab From 199235c021e8b193eeea3eeef7e3aaa36cf40721 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 3 Apr 2015 14:12:14 +0000 Subject: [PATCH 038/192] Update to latest hacking Change-Id: Ib077c249bcb7ca5f8f795bf94c75f7f1d15a5746 --- test-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-requirements.txt b/test-requirements.txt index b859e83..cda046a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -hacking>=0.9.2,<0.10 +hacking>=0.10.0,<0.11 # this is required for the docs build jobs sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 -- GitLab From 7ddfe1c965474f28a5a4a25062e0c35243ad6452 Mon Sep 17 00:00:00 2001 From: Anne Gentle Date: Wed, 8 Apr 2015 16:27:26 -0500 Subject: [PATCH 039/192] Adds javascript footer for Google Analytics tracking - Ensures tracking is across all openstack.org web properties - Tracks only docs.openstack.org/developer/{{ project }} where project name is taken from conf.py Change-Id: Idfb2696f42ff17cbc6c3b72afcd2630b9ae01f0e Closes-bug: 1441315 --- oslosphinx/theme/openstack/layout.html | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/oslosphinx/theme/openstack/layout.html b/oslosphinx/theme/openstack/layout.html index 1523bd0..8e534a8 100644 --- a/oslosphinx/theme/openstack/layout.html +++ b/oslosphinx/theme/openstack/layout.html @@ -85,3 +85,19 @@ {% endblock %} + +{% block footer %} +{{ super() }} + + +{% endblock %} -- GitLab From 33845ab55c238fffe746969600da5233e8c5e94b Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Thu, 9 Apr 2015 15:15:25 +0100 Subject: [PATCH 040/192] Remove the unneeded horizontal scrollbar Even on really large screens, the horizontal scrollbar is shown. This is because the `div.related` class has a width of 100% in basic.css and in tweaks.css a border is also defined. This causes the div to be two pixes wider than the screen. Change-Id: I2881d8eca99988ff8372b22aecc1a1a90c66a314 --- oslosphinx/theme/openstack/static/basic.css | 1 - 1 file changed, 1 deletion(-) diff --git a/oslosphinx/theme/openstack/static/basic.css b/oslosphinx/theme/openstack/static/basic.css index cc289c8..f64795d 100644 --- a/oslosphinx/theme/openstack/static/basic.css +++ b/oslosphinx/theme/openstack/static/basic.css @@ -12,7 +12,6 @@ div.clearer { /* -- relbar ---------------------------------------------------------------- */ div.related { - width: 100%; font-size: 90%; } -- GitLab From e5e8fd8e0b2f20063bbfb0d16ebe718f293b775e Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Mon, 27 Apr 2015 07:43:03 +0000 Subject: [PATCH 041/192] Uploading to unstable. --- debian/changelog | 1 + debian/control | 18 +++++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/debian/changelog b/debian/changelog index 6296b1f..b4ac744 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,6 +2,7 @@ oslo-sphinx (2.5.0-1) UNRELEASED; urgency=medium * New upstream release. * Added python-pbr and python-requests as new Depends. + * Uploading to unstable. -- Thomas Goirand Wed, 25 Feb 2015 10:20:53 +0100 diff --git a/debian/control b/debian/control index 3bb02f1..66ebe16 100644 --- a/debian/control +++ b/debian/control @@ -2,13 +2,15 @@ Source: oslo-sphinx Section: python Priority: optional Maintainer: PKG OpenStack -Uploaders: Thomas Goirand +Uploaders: Thomas Goirand , Build-Depends: debhelper (>= 9), openstack-pkg-tools, python-all (>= 2.6.6-3~), python-pbr, - python-setuptools -Build-Depends-Indep: python-d2to1, python-hacking, python-requests (>= 2.2.0) + python-setuptools, +Build-Depends-Indep: python-d2to1, + python-hacking, + python-requests (>= 2.2.0), Standards-Version: 3.9.5 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git @@ -16,11 +18,11 @@ Homepage: https://github.com/openstack/oslo.sphinx Package: python-oslosphinx Architecture: all -Pre-Depends: dpkg (>= 1.15.6~) +Pre-Depends: dpkg (>= 1.15.6~), Depends: python-pbr (>= 0.6), python-requests (>= 2.2.0), ${misc:Depends}, - ${python:Depends} + ${python:Depends}, Description: theme and extension support for openstack Theme and extension support for Sphinx documentation from the OpenStack project. To use the theme, symply add 'oslosphinx' to the extensions list in @@ -28,8 +30,10 @@ Description: theme and extension support for openstack Package: python-oslo.sphinx Architecture: all -Pre-Depends: dpkg (>= 1.15.6~) -Depends: python-oslosphinx, ${misc:Depends}, ${python:Depends} +Pre-Depends: dpkg (>= 1.15.6~), +Depends: python-oslosphinx, + ${misc:Depends}, + ${python:Depends}, Description: theme and extension support for openstack - transition package Theme and extension support for Sphinx documentation from the OpenStack project. To use the theme, symply add 'oslosphinx' to the extensions list in -- GitLab From 5a2bf86170f919782da65257ecd7655a0bcd1891 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Mon, 27 Apr 2015 07:47:03 +0000 Subject: [PATCH 042/192] Drops python-oslo.sphinx transition package after the release of Jessie. --- debian/changelog | 1 + debian/control | 25 ++++++------------------- 2 files changed, 7 insertions(+), 19 deletions(-) diff --git a/debian/changelog b/debian/changelog index b4ac744..31ca2ec 100644 --- a/debian/changelog +++ b/debian/changelog @@ -3,6 +3,7 @@ oslo-sphinx (2.5.0-1) UNRELEASED; urgency=medium * New upstream release. * Added python-pbr and python-requests as new Depends. * Uploading to unstable. + * Drops python-oslo.sphinx transition package after the release of Jessie. -- Thomas Goirand Wed, 25 Feb 2015 10:20:53 +0100 diff --git a/debian/control b/debian/control index 66ebe16..7d4f845 100644 --- a/debian/control +++ b/debian/control @@ -4,13 +4,13 @@ Priority: optional Maintainer: PKG OpenStack Uploaders: Thomas Goirand , Build-Depends: debhelper (>= 9), - openstack-pkg-tools, + dh-python, + openstack-pkg-tools (>= 23~), python-all (>= 2.6.6-3~), python-pbr, python-setuptools, -Build-Depends-Indep: python-d2to1, - python-hacking, - python-requests (>= 2.2.0), +Build-Depends-Indep: python-hacking, + python-requests, Standards-Version: 3.9.5 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git @@ -19,24 +19,11 @@ Homepage: https://github.com/openstack/oslo.sphinx Package: python-oslosphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~), -Depends: python-pbr (>= 0.6), - python-requests (>= 2.2.0), +Depends: python-pbr, + python-requests, ${misc:Depends}, ${python:Depends}, Description: theme and extension support for openstack Theme and extension support for Sphinx documentation from the OpenStack project. To use the theme, symply add 'oslosphinx' to the extensions list in the conf.py file in your Sphinx project. - -Package: python-oslo.sphinx -Architecture: all -Pre-Depends: dpkg (>= 1.15.6~), -Depends: python-oslosphinx, - ${misc:Depends}, - ${python:Depends}, -Description: theme and extension support for openstack - transition package - Theme and extension support for Sphinx documentation from the OpenStack - project. To use the theme, symply add 'oslosphinx' to the extensions list in - the conf.py file in your Sphinx project. - . - This is a dummy transition package. -- GitLab From d18a6c93d76250043a2e10bbb7b1c6c60de8c2c9 Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Mon, 27 Apr 2015 07:58:52 +0000 Subject: [PATCH 043/192] Standards-Version: 3.9.6 --- debian/changelog | 3 ++- debian/control | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index 31ca2ec..190776b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,9 +1,10 @@ -oslo-sphinx (2.5.0-1) UNRELEASED; urgency=medium +oslo-sphinx (2.5.0-1) unstable; urgency=medium * New upstream release. * Added python-pbr and python-requests as new Depends. * Uploading to unstable. * Drops python-oslo.sphinx transition package after the release of Jessie. + * Standards-Version: 3.9.6. -- Thomas Goirand Wed, 25 Feb 2015 10:20:53 +0100 diff --git a/debian/control b/debian/control index 7d4f845..16dbb0c 100644 --- a/debian/control +++ b/debian/control @@ -11,7 +11,7 @@ Build-Depends: debhelper (>= 9), python-setuptools, Build-Depends-Indep: python-hacking, python-requests, -Standards-Version: 3.9.5 +Standards-Version: 3.9.6 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git Homepage: https://github.com/openstack/oslo.sphinx -- GitLab From 6e76e425d7e4591243b3e57ccce0829605222d3a Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Mon, 4 May 2015 20:08:42 +0000 Subject: [PATCH 044/192] Updated from global requirements Change-Id: I1cca99b86c395d0025fcb73575e036e30b2cdb36 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 19d3ae5..1f446b5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,4 @@ # process, which may cause wedges in the gate later. pbr>=0.6,!=0.7,<1.0 -requests>=2.2.0,!=2.4.0 +requests>=2.5.2 -- GitLab From 90a1e5d5f517313f2c2a77918d97bae94a722417 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 1 May 2015 19:39:53 +0000 Subject: [PATCH 045/192] Remove run_cross_tests.sh This script is part of the oslotest package now. Change-Id: I14681b35dbcc9290adc59b77f73e1580a1f46acf --- openstack-common.conf | 3 -- tools/run_cross_tests.sh | 100 --------------------------------------- 2 files changed, 103 deletions(-) delete mode 100755 tools/run_cross_tests.sh diff --git a/openstack-common.conf b/openstack-common.conf index 2bae3b4..85fdb88 100644 --- a/openstack-common.conf +++ b/openstack-common.conf @@ -1,7 +1,4 @@ [DEFAULT] -# The list of modules to copy from oslo-incubator.git -script = tools/run_cross_tests.sh - # The base module to hold the copy of openstack.common base=oslosphinx diff --git a/tools/run_cross_tests.sh b/tools/run_cross_tests.sh deleted file mode 100755 index d61ae9d..0000000 --- a/tools/run_cross_tests.sh +++ /dev/null @@ -1,100 +0,0 @@ -#!/bin/bash -# -# Run cross-project tests -# -# Usage: -# -# run_cross_tests.sh project_dir venv - -# Fail the build if any command fails -set -e - -project_dir="$1" -shift -venv="$1" -shift -posargs="$*" - -if [ -z "$project_dir" -o -z "$venv" ] -then - cat - < ./subunit_log.txt - fi - .tox/$venv/bin/python /usr/local/jenkins/slave_scripts/subunit2html.py ./subunit_log.txt testr_results.html - gzip -9 ./subunit_log.txt - gzip -9 ./testr_results.html - - export PYTHON=.tox/$venv/bin/python - set -e - rancount=$(.tox/$venv/bin/testr last | sed -ne 's/Ran \([0-9]\+\).*tests in.*/\1/p') - if [ "$rancount" -eq "0" ] ; then - echo - echo "Zero tests were run. At least one test should have been run." - echo "Failing this test as a result" - echo - exit 1 - fi -fi - -# If we make it this far, report status based on the tests that were -# run. -exit $result -- GitLab From d79b8cc3ffe01a8a6e1911492413c9f01c0ecd15 Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Thu, 7 May 2015 23:36:54 +0000 Subject: [PATCH 046/192] Updated from global requirements Change-Id: I53fe1ede93a10518c4d97db8027034e380a06566 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1f446b5..cc4784c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr>=0.6,!=0.7,<1.0 +pbr>=0.11,<2.0 requests>=2.5.2 -- GitLab From 495aec3b4381889c06a6002dd687a59b843d427d Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Fri, 8 May 2015 16:08:21 -0400 Subject: [PATCH 047/192] Advertise support for Python3.4 / Remove support for Python 3.3 Change-Id: I2e5d3e5409cf08c69703f8cdf0ace0c2ac65f900 --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index a641fc3..dab5d4f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -17,7 +17,7 @@ classifier = Programming Language :: Python :: 2.6 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 - Programming Language :: Python :: 3.3 + Programming Language :: Python :: 3.4 Topic :: Documentation [global] -- GitLab From f14ad415adc246572c9eb85bdda9be2c4bcf9280 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Thu, 14 May 2015 21:38:20 +0000 Subject: [PATCH 048/192] Replace ci.o.o links with docs.o.o/infra The http://ci.openstack.org/ documentation site has been deprecated, replaced by redirects to corresponding paths within http://docs.openstack.org/infra/ where other Project Infrastructure documentation already resides. Change-Id: Ia914d1802b57f7101dd86b2098857dd714763dd1 --- oslosphinx/intersphinx.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/oslosphinx/intersphinx.py b/oslosphinx/intersphinx.py index d1ab95f..4439265 100644 --- a/oslosphinx/intersphinx.py +++ b/oslosphinx/intersphinx.py @@ -66,6 +66,6 @@ mapping = dict( trove=('http://docs.openstack.org/developer/trove/', None), # Other things of note python=('http://docs.python.org/', None), - infra=('http://ci.openstack.org/', None), - zuul=('http://ci.openstack.org/zuul/', None), + infra=('http://docs.openstack.org/infra/system-config/', None), + zuul=('http://docs.openstack.org/infra/zuul/', None), ) -- GitLab From 46832a8942c5f56f2cc8d1689304c57ab5c38c7e Mon Sep 17 00:00:00 2001 From: Joe Gordon Date: Wed, 27 May 2015 12:18:31 -0700 Subject: [PATCH 049/192] Drop incubating theme option OpenStack has dropped the incubation concept, so drop this label as a docs option. Change-Id: Ib95bb403d51ed3c7b682dd695713f43432cf8a4e --- oslosphinx/theme/openstack/layout.html | 3 --- 1 file changed, 3 deletions(-) diff --git a/oslosphinx/theme/openstack/layout.html b/oslosphinx/theme/openstack/layout.html index 8e534a8..2272675 100644 --- a/oslosphinx/theme/openstack/layout.html +++ b/oslosphinx/theme/openstack/layout.html @@ -12,9 +12,6 @@

{%- endif %} {%- endblock %} - {%- if theme_incubating|tobool %} -

{{ _('Incubated Project') }}

- {%- endif %} {%- block sidebartoc %} {%- if display_toc %}

{{ _('Table Of Contents') }}

-- GitLab From 774a129dcab04116fa7bcceaacb2fecaba391300 Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Tue, 16 Jun 2015 17:26:12 +0000 Subject: [PATCH 050/192] Updated from global requirements Change-Id: Ie2cca4e8cb2eade195cee152b54c6f567a11dc6f --- setup.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 setup.py diff --git a/setup.py b/setup.py old mode 100755 new mode 100644 -- GitLab From 01d3a5a662044535db26d4c8c828632401e6d2fa Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Mon, 22 Jun 2015 08:27:25 +0000 Subject: [PATCH 051/192] Updated from global requirements Change-Id: I7889ee5c3e1d9c686451149beaca09ba136026ec --- requirements.txt | 2 +- setup.py | 1 - test-requirements.txt | 4 ++-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/requirements.txt b/requirements.txt index cc4784c..81eacf7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr>=0.11,<2.0 +pbr<2.0,>=0.11 requests>=2.5.2 diff --git a/setup.py b/setup.py index 7363757..056c16c 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/test-requirements.txt b/test-requirements.txt index cda046a..87c1c20 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -hacking>=0.10.0,<0.11 +hacking<0.11,>=0.10.0 # this is required for the docs build jobs -sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 -- GitLab From 4436e1161bf14d232edab035199cf59b32436efa Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Wed, 15 Jul 2015 00:29:02 +0000 Subject: [PATCH 052/192] Updated from global requirements Change-Id: I45aab8ced05719e3189bb129afea54f8070f0b85 --- requirements.txt | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 81eacf7..5b1ba9e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr<2.0,>=0.11 +pbr<2.0,>=1.3 requests>=2.5.2 diff --git a/setup.py b/setup.py index 056c16c..d8080d0 100644 --- a/setup.py +++ b/setup.py @@ -25,5 +25,5 @@ except ImportError: pass setuptools.setup( - setup_requires=['pbr'], + setup_requires=['pbr>=1.3'], pbr=True) -- GitLab From 66f688aedcf3af7a96183f6561d05e539db90eb6 Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Mon, 10 Aug 2015 01:09:50 +0000 Subject: [PATCH 053/192] Updated from global requirements Change-Id: Id53b19b67a2dd99d568141d6d36b0cdb720dcf27 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 5b1ba9e..e19da6e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr<2.0,>=1.3 +pbr<2.0,>=1.4 requests>=2.5.2 -- GitLab From 3f9bccefc9f2bf5f2fbff1eb6cf6d35db39fa3fd Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Wed, 26 Aug 2015 14:08:08 +0000 Subject: [PATCH 054/192] Updated from global requirements Change-Id: Idaa1f7f8c45759bbb2af4abda7a635c5f92aec6f --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index e19da6e..aa8cbdf 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr<2.0,>=1.4 +pbr<2.0,>=1.6 requests>=2.5.2 -- GitLab From e9e52bd118fdf8ae8c14ec3706e0e95cf757fddb Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Thu, 17 Sep 2015 12:16:20 +0000 Subject: [PATCH 055/192] Updated from global requirements Change-Id: Id34a666b95d54872619a505dcf30fde391fddd5b --- requirements.txt | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index aa8cbdf..44da7c5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr<2.0,>=1.6 +pbr>=1.6 requests>=2.5.2 diff --git a/setup.py b/setup.py index d8080d0..782bb21 100644 --- a/setup.py +++ b/setup.py @@ -25,5 +25,5 @@ except ImportError: pass setuptools.setup( - setup_requires=['pbr>=1.3'], + setup_requires=['pbr>=1.8'], pbr=True) -- GitLab From efec9c68fe2fcc51c147c0b20228a57be60ff2db Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 24 Sep 2015 13:21:42 +0000 Subject: [PATCH 056/192] add link to project source in navigation sidebar Change-Id: I841f0e63259d6b79c55b223c8e7266c8520a668d Closes-Bug: #1426898 --- oslosphinx/__init__.py | 24 ++++++++++++++++++++++++ oslosphinx/theme/openstack/layout.html | 9 +++++++++ 2 files changed, 33 insertions(+) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index 4a238c0..24c7f40 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -13,6 +13,28 @@ # under the License. import os +import subprocess +import urlparse + + +CGIT_BASE = 'http://git.openstack.org/cgit/' +_cgit_link = None + + +def _html_page_context(app, pagename, templatename, context, doctree): + global _cgit_link + if _cgit_link is None: + try: + git_remote = subprocess.check_output( + ['git', 'config', '--local', '--get', 'remote.origin.url'] + ) + except subprocess.CheckedProcessException: + _cgit_link = 'unknown' + else: + parsed = urlparse.urlparse(git_remote) + _cgit_link = CGIT_BASE + parsed.path.lstrip('/') + context['cgit_link'] = _cgit_link + return context def builder_inited(app): @@ -33,6 +55,8 @@ def builder_inited(app): # the templates and theme. if hasattr(app.builder, 'init_templates'): app.builder.init_templates() + # Register our page context additions + app.connect('html-page-context', _html_page_context) def setup(app): diff --git a/oslosphinx/theme/openstack/layout.html b/oslosphinx/theme/openstack/layout.html index 2272675..512ab3f 100644 --- a/oslosphinx/theme/openstack/layout.html +++ b/oslosphinx/theme/openstack/layout.html @@ -30,6 +30,15 @@ title="{{ _('next chapter') }}">{{ next.title }}

{%- endif %} {%- endblock %} + {%- block projectsource %} + {%- if cgit_link %} +

{{ _('Project Source') }}

+ + {%- endif %} + {%- endblock %} {%- block sidebarsourcelink %} {%- if show_source and has_source and sourcename %}

{{ _('This Page') }}

-- GitLab From fa83ee0dc54e6e11ad53ad01540d3d6e07f89b02 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 24 Sep 2015 19:41:29 +0000 Subject: [PATCH 057/192] add pbr-generated release history to the doc build Change-Id: I5d24d269a3861c56df0a08fb7e1dcc86e1336e36 --- doc/source/history.rst | 1 + doc/source/index.rst | 8 ++++++++ 2 files changed, 9 insertions(+) create mode 100644 doc/source/history.rst diff --git a/doc/source/history.rst b/doc/source/history.rst new file mode 100644 index 0000000..69ed4fe --- /dev/null +++ b/doc/source/history.rst @@ -0,0 +1 @@ +.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 6481815..7850c45 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,14 @@ check_blueprints contributing +Release Notes +============= + +.. toctree:: + :maxdepth: 1 + + history + Indices and tables ================== -- GitLab From 6ebaef6ba4edb4e336a23d34418519e05977e8c1 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 24 Sep 2015 19:41:44 +0000 Subject: [PATCH 058/192] clean up documentation titles and intros Change-Id: I9f1bf4e912e53500f603cecb23f86b48d5dbc159 --- README.rst | 5 +++-- doc/source/index.rst | 9 ++++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 16b5b96..2b3238c 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,6 @@ -OpenStack Sphinx Extensions -=========================== +============================= + OpenStack Sphinx Extensions +============================= Theme and extension support for Sphinx documentation from the OpenStack project. diff --git a/doc/source/index.rst b/doc/source/index.rst index 7850c45..543e0a8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,6 +1,9 @@ -============ - oslosphinx -============ +============================================ + oslosphinx --- OpenStack Sphinx Extensions +============================================ + +oslosphinx contains the theme and extension support for Sphinx +documentation from the OpenStack project. .. toctree:: :maxdepth: 2 -- GitLab From ff59f302c48dea4723381fa036ad7bf5e13c128e Mon Sep 17 00:00:00 2001 From: "THOMAS J. COCOZZELLO" Date: Thu, 24 Sep 2015 07:47:28 -0500 Subject: [PATCH 059/192] Titles in table of contents continue into the page In the table of contents the titles are covering words in the page, this won't be a problem but the directories that are in the table of contents are considered 1 word so it does not word wrap automatically Change-Id: I763aa1ba4418be1ea70d1ff48a321971630ec6e4 Closes-Bug: 1498654 --- oslosphinx/theme/openstack/static/basic.css | 2 +- oslosphinx/theme/openstack/static/tweaks.css | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/oslosphinx/theme/openstack/static/basic.css b/oslosphinx/theme/openstack/static/basic.css index f64795d..5542eea 100644 --- a/oslosphinx/theme/openstack/static/basic.css +++ b/oslosphinx/theme/openstack/static/basic.css @@ -42,7 +42,7 @@ div.sphinxsidebarwrapper { div.sphinxsidebar { float: left; - width: 230px; + width: 260px; margin-left: -100%; font-size: 90%; } diff --git a/oslosphinx/theme/openstack/static/tweaks.css b/oslosphinx/theme/openstack/static/tweaks.css index 9b3a6ce..5bd5ff2 100644 --- a/oslosphinx/theme/openstack/static/tweaks.css +++ b/oslosphinx/theme/openstack/static/tweaks.css @@ -85,7 +85,7 @@ a.headerlink { div.body { margin-top: -25px; - margin-left: 230px; + margin-left: 260px; } div.document { @@ -113,3 +113,16 @@ div.sphinxsidebar ul li ul li { margin-top: 0; font-weight: normal; } + +/** Provide the sidebar to allow long words to go to the next line + making them easier to read.*/ +div.sphinxsidebar a { + display: block; + text-indent: -1em; + margin-left: 1em; + word-wrap: break-word; +} + +div.sphinxsidebar ul { + margin: 10px 10px; +} \ No newline at end of file -- GitLab From 36dd92b1e1e6dcb705ca71cb5ae5fb517c259e4d Mon Sep 17 00:00:00 2001 From: Javier Pena Date: Fri, 25 Sep 2015 16:23:18 +0200 Subject: [PATCH 060/192] Fix subprocess exception name https://review.openstack.org/227299 added code using subprocess.CheckedProcessException, which does not exist. From the Python documentation, it should be subprocess.CalledProcessError [1] [1] - https://docs.python.org/2/library/subprocess.html#subprocess.CalledProcessError Change-Id: I0e03f048a33b1b919e38d22038650a633b8ac5fd --- oslosphinx/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index 24c7f40..d31e81d 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -28,7 +28,7 @@ def _html_page_context(app, pagename, templatename, context, doctree): git_remote = subprocess.check_output( ['git', 'config', '--local', '--get', 'remote.origin.url'] ) - except subprocess.CheckedProcessException: + except subprocess.CalledProcessError: _cgit_link = 'unknown' else: parsed = urlparse.urlparse(git_remote) -- GitLab From 2525bb98d17c239e45342e4191bd946e74484a9e Mon Sep 17 00:00:00 2001 From: Javier Pena Date: Mon, 28 Sep 2015 10:56:05 +0200 Subject: [PATCH 061/192] Make urlparse import Python3-compatible urlparse moved to urllib.parse, so the current code fails in Python3. Using six to ensure compatibility. Related-Bug: #1426898 Change-Id: I9297c886dcc361238e942cb8162f589072001094 --- oslosphinx/__init__.py | 4 ++-- requirements.txt | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index d31e81d..f788147 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -13,8 +13,8 @@ # under the License. import os +from six.moves.urllib import parse import subprocess -import urlparse CGIT_BASE = 'http://git.openstack.org/cgit/' @@ -31,7 +31,7 @@ def _html_page_context(app, pagename, templatename, context, doctree): except subprocess.CalledProcessError: _cgit_link = 'unknown' else: - parsed = urlparse.urlparse(git_remote) + parsed = parse.urlparse(git_remote) _cgit_link = CGIT_BASE + parsed.path.lstrip('/') context['cgit_link'] = _cgit_link return context diff --git a/requirements.txt b/requirements.txt index 44da7c5..ac98e29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,4 @@ pbr>=1.6 requests>=2.5.2 +six>=1.9.0 -- GitLab From db1a4034bfe52d9164aa09f3a8ce12f7de9fe10c Mon Sep 17 00:00:00 2001 From: Corey Bryant Date: Wed, 30 Sep 2015 21:29:30 -0400 Subject: [PATCH 062/192] New upstream release. --- debian/changelog | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/debian/changelog b/debian/changelog index 190776b..1089113 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +oslo-sphinx (3.2.0-1) UNRELEASED; urgency=medium + + * New upstream release. + + -- Corey Bryant Wed, 30 Sep 2015 21:23:21 -0400 + oslo-sphinx (2.5.0-1) unstable; urgency=medium * New upstream release. -- GitLab From 6a8e9ac8c52f6a1f97810555271c50fc1ae87206 Mon Sep 17 00:00:00 2001 From: Corey Bryant Date: Wed, 30 Sep 2015 21:45:14 -0400 Subject: [PATCH 063/192] d/control: Align dependencies with upstream. --- debian/changelog | 1 + debian/control | 11 ++++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/debian/changelog b/debian/changelog index 1089113..d9bf830 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,6 +1,7 @@ oslo-sphinx (3.2.0-1) UNRELEASED; urgency=medium * New upstream release. + * d/control: Align dependencies with upstream. -- Corey Bryant Wed, 30 Sep 2015 21:23:21 -0400 diff --git a/debian/control b/debian/control index 16dbb0c..af33eff 100644 --- a/debian/control +++ b/debian/control @@ -7,10 +7,11 @@ Build-Depends: debhelper (>= 9), dh-python, openstack-pkg-tools (>= 23~), python-all (>= 2.6.6-3~), - python-pbr, + python-pbr (>= 1.8), python-setuptools, -Build-Depends-Indep: python-hacking, - python-requests, + python-sphinx, +Build-Depends-Indep: python-hacking (>= 0.10.0), + python-requests (>= 2.5.2), Standards-Version: 3.9.6 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git @@ -19,8 +20,8 @@ Homepage: https://github.com/openstack/oslo.sphinx Package: python-oslosphinx Architecture: all Pre-Depends: dpkg (>= 1.15.6~), -Depends: python-pbr, - python-requests, +Depends: python-pbr (>= 1.8), + python-requests (>= 2.5.2), ${misc:Depends}, ${python:Depends}, Description: theme and extension support for openstack -- GitLab From 1d61cedc836c739edad87698a9f9292dad82c7ff Mon Sep 17 00:00:00 2001 From: Corey Bryant Date: Wed, 30 Sep 2015 21:45:57 -0400 Subject: [PATCH 064/192] d/gbp.conf: Update debian-branch to debian/liberty. --- debian/changelog | 1 + debian/gbp.conf | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index d9bf830..f709b5c 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,6 +2,7 @@ oslo-sphinx (3.2.0-1) UNRELEASED; urgency=medium * New upstream release. * d/control: Align dependencies with upstream. + * d/gbp.conf: Update debian-branch to debian/liberty. -- Corey Bryant Wed, 30 Sep 2015 21:23:21 -0400 diff --git a/debian/gbp.conf b/debian/gbp.conf index a281224..543785d 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/kilo +debian-branch = debian/liberty upstream-tag = %(version)s compression = xz -- GitLab From 81347c7cc3d44fef51bbe89074e54fca20e37c40 Mon Sep 17 00:00:00 2001 From: Corey Bryant Date: Wed, 30 Sep 2015 21:46:33 -0400 Subject: [PATCH 065/192] d/control: Update uploaders. --- debian/changelog | 1 + debian/control | 1 + 2 files changed, 2 insertions(+) diff --git a/debian/changelog b/debian/changelog index f709b5c..b0b959e 100644 --- a/debian/changelog +++ b/debian/changelog @@ -3,6 +3,7 @@ oslo-sphinx (3.2.0-1) UNRELEASED; urgency=medium * New upstream release. * d/control: Align dependencies with upstream. * d/gbp.conf: Update debian-branch to debian/liberty. + * d/control: Update uploaders. -- Corey Bryant Wed, 30 Sep 2015 21:23:21 -0400 diff --git a/debian/control b/debian/control index af33eff..ced45a7 100644 --- a/debian/control +++ b/debian/control @@ -3,6 +3,7 @@ Section: python Priority: optional Maintainer: PKG OpenStack Uploaders: Thomas Goirand , + Corey Bryant , Build-Depends: debhelper (>= 9), dh-python, openstack-pkg-tools (>= 23~), -- GitLab From 014df1a17447a5186f4545f7e32727e7f02dd547 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Sun, 4 Oct 2015 19:40:10 -0400 Subject: [PATCH 066/192] No need for Oslo Incubator Sync We can remove openstack-common.conf as we don't sync any code from oslo-incubator any more. Change-Id: I600132f6c59bc8adf06c1edbe488fba0d5ee795b --- openstack-common.conf | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 openstack-common.conf diff --git a/openstack-common.conf b/openstack-common.conf deleted file mode 100644 index 85fdb88..0000000 --- a/openstack-common.conf +++ /dev/null @@ -1,4 +0,0 @@ -[DEFAULT] - -# The base module to hold the copy of openstack.common -base=oslosphinx -- GitLab From 53c4ae72e9940c917c8b4fc9a48b8aa4eeda7c81 Mon Sep 17 00:00:00 2001 From: OpenStack Proposal Bot Date: Fri, 9 Oct 2015 05:04:02 +0000 Subject: [PATCH 067/192] Updated from global requirements Change-Id: Ib8e15a9f3da8800687d4244540b7a8aa902e5d14 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index ac98e29..bc07a27 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,5 +3,5 @@ # process, which may cause wedges in the gate later. pbr>=1.6 -requests>=2.5.2 +requests!=2.8.0,>=2.5.2 six>=1.9.0 -- GitLab From cd2674bb9501b0216dc81ede635e84c379b6309d Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 12 Oct 2015 19:50:40 +0000 Subject: [PATCH 068/192] fix html-page-context event handler The event handler should return a string if it wants to replace the template, but should otherwise return None and update the context in place. Change-Id: Ic4b19c7d19eda866ba139913cf817c99a65c8c08 Closes-Bug: #1505311 --- oslosphinx/__init__.py | 1 - 1 file changed, 1 deletion(-) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index f788147..c088e84 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -34,7 +34,6 @@ def _html_page_context(app, pagename, templatename, context, doctree): parsed = parse.urlparse(git_remote) _cgit_link = CGIT_BASE + parsed.path.lstrip('/') context['cgit_link'] = _cgit_link - return context def builder_inited(app): -- GitLab From c383e0026aeb9fb541486f41cf286256e312e5e3 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 16 Oct 2015 20:37:34 +0000 Subject: [PATCH 069/192] add config option to point to the cgit browser Add a configuration option to let projects set the URL to the cgit browser for their source. Still try to guess at the location based on our git URL. Change-Id: I11455f8a137a029c28a864eb555f69f6c282840b --- doc/source/conf.py | 4 +++- doc/source/usage.rst | 11 +++++++++++ oslosphinx/__init__.py | 32 +++++++++++++++++++------------- 3 files changed, 33 insertions(+), 14 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 8b66547..09b7191 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,6 +26,8 @@ extensions = [ 'oslosphinx' ] +oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/oslosphinx' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -72,4 +74,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/usage.rst b/doc/source/usage.rst index a291a3c..5aca6b5 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -13,3 +13,14 @@ If you are an incubating project, set:: html_theme_options = {'incubating': True} in your conf.py as well, to enable the Incubation theme. + +Linking to a Source Repository +============================== + +``oslosphinx`` defines a configuration option ``oslosphinx_cgit_link`` +which should be the URL to the git repository browser for the project +being documented. The default is a guess, and will be right for a lot +of projects, but to ensure that it is correct in all situations it is +best to set the value in conf.py:: + + oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/oslosphinx' diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index c088e84..a7d3c10 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -18,22 +18,24 @@ import subprocess CGIT_BASE = 'http://git.openstack.org/cgit/' -_cgit_link = None + + +def _guess_cgit_link(): + try: + git_remote = subprocess.check_output( + ['git', 'config', '--local', '--get', 'remote.origin.url'] + ) + except subprocess.CalledProcessError: + return None + else: + parsed = parse.urlparse(git_remote) + return CGIT_BASE + parsed.path.lstrip('/') def _html_page_context(app, pagename, templatename, context, doctree): - global _cgit_link - if _cgit_link is None: - try: - git_remote = subprocess.check_output( - ['git', 'config', '--local', '--get', 'remote.origin.url'] - ) - except subprocess.CalledProcessError: - _cgit_link = 'unknown' - else: - parsed = parse.urlparse(git_remote) - _cgit_link = CGIT_BASE + parsed.path.lstrip('/') - context['cgit_link'] = _cgit_link + # Insert the cgit link into the template context. + context['cgit_link'] = app.config.oslosphinx_cgit_link + return context def builder_inited(app): @@ -60,3 +62,7 @@ def builder_inited(app): def setup(app): app.connect('builder-inited', builder_inited) + # Try to guess at the default value for where the cgit repository + # is. + cgit_link = _guess_cgit_link() + app.add_config_value('oslosphinx_cgit_link', cgit_link, 'env') -- GitLab From a3f3bf8b1dde3644704ff89ed3567e64223b0ac8 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Sun, 15 Nov 2015 10:21:11 -0500 Subject: [PATCH 070/192] cleanup tox.ini * Remove usedevelop : only needed when skipsdist is set to True * Remove install_command : We can just use the default, we don't need to override * Remove setenv : We can just use the default as we don't need any extra environment variables * sitepackages : default is already false Change-Id: Id13307a8f7c21496e1d5aad20cd9e2146b8f2fbd --- tox.ini | 4 ---- 1 file changed, 4 deletions(-) diff --git a/tox.ini b/tox.ini index 16a6e89..4682314 100644 --- a/tox.ini +++ b/tox.ini @@ -3,11 +3,7 @@ minversion = 1.6 envlist = pep8 [testenv] -usedevelop = True -install_command = pip install -U {opts} {packages} deps = -r{toxinidir}/test-requirements.txt -setenv = VIRTUAL_ENV={envdir} -sitepackages = False downloadcache = {toxworkdir}/_download [testenv:pep8] -- GitLab From 0b555a001f5c2bf9bbc6464e8be5aae04c805f35 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 17 Nov 2015 01:06:00 +0000 Subject: [PATCH 071/192] fix html context event handler The event handler should return a replacement template *name* or None. Since we don't want to change the template, return None. Change-Id: I3012ad22505230c488aa4babbd4141d903b7ab0d Closes-Bug: 1516834 --- oslosphinx/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index a7d3c10..0abc967 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -35,7 +35,7 @@ def _guess_cgit_link(): def _html_page_context(app, pagename, templatename, context, doctree): # Insert the cgit link into the template context. context['cgit_link'] = app.config.oslosphinx_cgit_link - return context + return None def builder_inited(app): -- GitLab From da4cfa3f97dfa7454d40fc430e35e4f31cb0c1e4 Mon Sep 17 00:00:00 2001 From: "ChangBo Guo(gcb)" Date: Tue, 17 Nov 2015 15:46:21 +0800 Subject: [PATCH 072/192] Remove Python 2.6 classifier We have decided to remove Python 2.6 support, this commit removes Python 2.6 classifier before dropping any Python 2.6 support in code. Change-Id: I31d54e5fb1f18e49df42fef2863e70af6b2fdea1 --- setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index dab5d4f..26fd436 100644 --- a/setup.cfg +++ b/setup.cfg @@ -14,7 +14,6 @@ classifier = Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 2 - Programming Language :: Python :: 2.6 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 Programming Language :: Python :: 3.4 -- GitLab From 10d552993479e07a14a0492f1242ee752d4b9940 Mon Sep 17 00:00:00 2001 From: Cyril Roelandt Date: Wed, 18 Nov 2015 17:06:23 +0100 Subject: [PATCH 073/192] Fix a string vs bytes issue in _guess_cgit_link subprocess.check_output returns bytes, so we end up using '+' on a text string (CGIT_BASE) and bytes (the output of parsed.path) in _guess_cgit_link. Make sure we decode 'git_remote' in Python 3. Change-Id: I9e846e2192ead41ca2328b8aa20994742096c51e Closes-Bug: #1517525 --- oslosphinx/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/oslosphinx/__init__.py b/oslosphinx/__init__.py index 0abc967..7f311c8 100644 --- a/oslosphinx/__init__.py +++ b/oslosphinx/__init__.py @@ -13,6 +13,7 @@ # under the License. import os +import six from six.moves.urllib import parse import subprocess @@ -28,6 +29,8 @@ def _guess_cgit_link(): except subprocess.CalledProcessError: return None else: + if six.PY3: + git_remote = os.fdecode(git_remote) parsed = parse.urlparse(git_remote) return CGIT_BASE + parsed.path.lstrip('/') -- GitLab From 30b40a0d6c503b5cc50e5d26484f813780288c8e Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Tue, 24 Nov 2015 13:48:10 +0100 Subject: [PATCH 074/192] Now packaging 4.0.0 --- debian/changelog | 2 +- debian/control | 5 +++-- debian/gbp.conf | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/debian/changelog b/debian/changelog index b0b959e..8f1ea81 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -oslo-sphinx (3.2.0-1) UNRELEASED; urgency=medium +oslo-sphinx (4.0.0-1) UNRELEASED; urgency=medium * New upstream release. * d/control: Align dependencies with upstream. diff --git a/debian/control b/debian/control index ced45a7..261a9f5 100644 --- a/debian/control +++ b/debian/control @@ -7,12 +7,13 @@ Uploaders: Thomas Goirand , Build-Depends: debhelper (>= 9), dh-python, openstack-pkg-tools (>= 23~), - python-all (>= 2.6.6-3~), + python-all, python-pbr (>= 1.8), python-setuptools, python-sphinx, Build-Depends-Indep: python-hacking (>= 0.10.0), python-requests (>= 2.5.2), + python-six (>= 1.9.0), Standards-Version: 3.9.6 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/oslo-sphinx.git Vcs-Git: git://anonscm.debian.org/openstack/oslo-sphinx.git @@ -20,9 +21,9 @@ Homepage: https://github.com/openstack/oslo.sphinx Package: python-oslosphinx Architecture: all -Pre-Depends: dpkg (>= 1.15.6~), Depends: python-pbr (>= 1.8), python-requests (>= 2.5.2), + python-six (>= 1.9.0), ${misc:Depends}, ${python:Depends}, Description: theme and extension support for openstack diff --git a/debian/gbp.conf b/debian/gbp.conf index 543785d..e632c63 100644 --- a/debian/gbp.conf +++ b/debian/gbp.conf @@ -1,6 +1,6 @@ [DEFAULT] upstream-branch = master -debian-branch = debian/liberty +debian-branch = debian/mitaka upstream-tag = %(version)s compression = xz -- GitLab From f3f59248bbcf55f30dd73ae9072a5bf4a29d3abf Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 26 Nov 2015 15:02:48 +0100 Subject: [PATCH 075/192] Add patch to remove google-analytics.com javascript. --- debian/changelog | 8 ++++++-- debian/patches/remove-google-analytics.patch | 18 ++++++++++++++++++ debian/patches/series | 1 + 3 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 debian/patches/remove-google-analytics.patch create mode 100644 debian/patches/series diff --git a/debian/changelog b/debian/changelog index 8f1ea81..1aa9340 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,11 +1,15 @@ -oslo-sphinx (4.0.0-1) UNRELEASED; urgency=medium +oslo-sphinx (4.0.0-2) UNRELEASED; urgency=medium + [ Corey Bryant ] * New upstream release. * d/control: Align dependencies with upstream. * d/gbp.conf: Update debian-branch to debian/liberty. * d/control: Update uploaders. - -- Corey Bryant Wed, 30 Sep 2015 21:23:21 -0400 + [ Thomas Goirand ] + * Add patch to remove google-analytics.com javascript. + + -- Thomas Goirand Thu, 26 Nov 2015 15:02:24 +0100 oslo-sphinx (2.5.0-1) unstable; urgency=medium diff --git a/debian/patches/remove-google-analytics.patch b/debian/patches/remove-google-analytics.patch new file mode 100644 index 0000000..4993f85 --- /dev/null +++ b/debian/patches/remove-google-analytics.patch @@ -0,0 +1,18 @@ +Description: Removes Google Analytics JS +Author: Thomas Goirand +Forwarded: https://review.openstack.org/#/c/250389/ +Last-Update: 2015-11-26 + +--- oslo-sphinx-4.0.0.orig/oslosphinx/theme/openstack/layout.html ++++ oslo-sphinx-4.0.0/oslosphinx/theme/openstack/layout.html +@@ -95,10 +95,6 @@ + {% block footer %} + {{ super() }} + +-