Imported Upstream version 3.0.1

diff --git a/ChangeLog b/ChangeLog
index a1529c5b21fbfc8f114b5e7a062557493bc02a19..4bc014435fa940d4c523c1acac8f5dde79ca33de 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,14 @@
 CHANGES
 =======
 
+3.0.1
+-----
+
+* builddoc: uses the new Sphinx 1.6 code for multiple builder
+* Updated from global requirements
+* Fix missing comment from previous change
+* trivial: Add note about multiple builders support
+
 3.0.0
 -----
 
@@ -17,6 +25,7 @@ CHANGES
 * Lazy import pkg\_resources
 * Add Changelog build handling for invalid chars
 * Initialize sphinx config using application instead of config
+* Make oslosphinx optional
 * Updated from global requirements
 * Also generate XML coverage report
 * Update to a newer hacking library

diff --git a/PKG-INFO b/PKG-INFO
index ef245d8fd0c1e429b7fdd351c01fe8e6ca14968e..3e4471a2f8c301e228abdc12106da65de45c222a 100644 (file)
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: pbr
-Version: 3.0.0
+Version: 3.0.1
 Summary: Python Build Reasonableness
 Home-page: http://docs.openstack.org/developer/pbr/
 Author: OpenStack

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 31003c1d7d56a90f8a4e71e20df5b221fec96ff4..f0a78ecc37ca8272ed7a9cb95cbbca53de1433dc 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -8,8 +8,14 @@ sys.path.insert(0, os.path.abspath('../..'))
 
 # 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',
-              'oslosphinx']
+extensions = ['sphinx.ext.autodoc']
+# make oslosphinx optional to not increase the needed dependencies
+try:
+    import oslosphinx
+except ImportError:
+    pass
+else:
+    extensions.append('oslosphinx')
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.

diff --git a/pbr.egg-info/PKG-INFO b/pbr.egg-info/PKG-INFO
index ef245d8fd0c1e429b7fdd351c01fe8e6ca14968e..3e4471a2f8c301e228abdc12106da65de45c222a 100644 (file)
--- a/pbr.egg-info/PKG-INFO
+++ b/pbr.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: pbr
-Version: 3.0.0
+Version: 3.0.1
 Summary: Python Build Reasonableness
 Home-page: http://docs.openstack.org/developer/pbr/
 Author: OpenStack

diff --git a/pbr/builddoc.py b/pbr/builddoc.py
index 343f7c3c2b13496928a90aa8dd671e07f3184984..1d31502fee1884a230ff00cb28e10572a8524df8 100644 (file)
--- a/pbr/builddoc.py
+++ b/pbr/builddoc.py
@@ -183,6 +183,14 @@ class LocalBuildDoc(setup_command.BuildDoc):
                         "autodoc_exclude_modules",
                         [None, ""])[1].split()))
 
+        # TODO(stephenfin): Deprecate this functionality once we depend on
+        # Sphinx 1.6, which includes a similar feature, in g-r
+        # https://github.com/sphinx-doc/sphinx/pull/3476
+        self.finalize_options()
+        if hasattr(self, "builder_target_dirs"):
+            # Sphinx >= 1.6.1
+            return setup_command.BuildDoc.run(self)
+        # Sphinx < 1.6
         for builder in self.builders:
             self.builder = builder
             self.finalize_options()

diff --git a/pbr/git.py b/pbr/git.py
index 1c70194e61b73738efd1c2e5750dc5706441fb75..f2855dde15d2f3cfcede02948fdc22b629f2e3b5 100644 (file)
--- a/pbr/git.py
+++ b/pbr/git.py
@@ -146,15 +146,14 @@ def get_git_short_sha(git_dir=None):
 def _clean_changelog_message(msg):
     """Cleans any instances of invalid sphinx wording.
 
-    This removes any instances of invalid characters or wording
+    This escapes/removes any instances of invalid characters
     that can be interpreted by sphinx as a warning or error
     when translating the Changelog into an HTML file for
     documentation building within projects.
 
-    Currently removes:
-    * Escapes any '_' that sphinx can interpret as a link
-    * Escapes any '*' with sphinx will interpret as a new commit
-
+    * Escapes '_' which is interpreted as a link
+    * Escapes '*' which is interpreted as a new line
+    * Escapes '`' which is interpreted as a literal
     """
 
     msg = msg.replace('*', '\*')

diff --git a/test-requirements.txt b/test-requirements.txt
index 9af272838450d4d1913edfcfa1589e786762f683..c40f6e505eaf8ef812807434acbbf1069ec14615 100644 (file)
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,7 +1,7 @@
 # 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.
-coverage>=4.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
 fixtures>=3.0.0 # Apache-2.0/BSD
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
 mock>=2.0 # BSD