diff options
author | Jenkins <jenkins@review.openstack.org> | 2015-05-04 13:43:53 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2015-05-04 13:43:53 +0000 |
commit | bcb2022eb069a72c2e8c47b1777f46ccd9ec6535 (patch) | |
tree | 9127e93a71f7077420c295039402e6902f839e45 | |
parent | cfd8ab2dec5cb85cb2de74a7ee3c5c6195f6b12b (diff) | |
parent | 702042e7968404d181aa516201e46bf5ff9c469f (diff) | |
download | pbr-bcb2022eb069a72c2e8c47b1777f46ccd9ec6535.tar.gz |
Merge "Allow overwriting sphinx builder from command line"
-rw-r--r-- | pbr/builddoc.py | 4 | ||||
-rw-r--r-- | pbr/tests/test_setup.py | 35 |
2 files changed, 39 insertions, 0 deletions
diff --git a/pbr/builddoc.py b/pbr/builddoc.py index f1822da..7c9916b 100644 --- a/pbr/builddoc.py +++ b/pbr/builddoc.py @@ -198,6 +198,10 @@ class LocalBuildDoc(setup_command.BuildDoc): def finalize_options(self): # Not a new style class, super keyword does not work. setup_command.BuildDoc.finalize_options(self) + # Handle builder option from command line - override cfg + option_dict = self.distribution.get_option_dict('build_sphinx') + if 'command line' in option_dict.get('builder', [[]])[0]: + self.builders = option_dict['builder'][1] # Allow builders to be configurable - as a comma separated list. if not isinstance(self.builders, list) and self.builders: self.builders = self.builders.split(',') diff --git a/pbr/tests/test_setup.py b/pbr/tests/test_setup.py index 9f66f7a..252658c 100644 --- a/pbr/tests/test_setup.py +++ b/pbr/tests/test_setup.py @@ -275,6 +275,41 @@ class BuildSphinxTest(base.BaseTestCase): self.assertIn('man', build_doc.builders) self.assertIn('doctest', build_doc.builders) + def test_cmd_builder_override(self): + + if self.has_opt: + self.distr.command_options["pbr"] = { + "autodoc_index_modules": ('setup.cfg', self.autodoc) + } + + self.distr.command_options["build_sphinx"]["builder"] = ( + "command line", "non-existing-builder") + + build_doc = packaging.LocalBuildDoc(self.distr) + self.assertNotIn('non-existing-builder', build_doc.builders) + self.assertIn('html', build_doc.builders) + + # process command line options which should override config + build_doc.finalize_options() + + self.assertIn('non-existing-builder', build_doc.builders) + self.assertNotIn('html', build_doc.builders) + + def test_cmd_builder_override_multiple_builders(self): + + if self.has_opt: + self.distr.command_options["pbr"] = { + "autodoc_index_modules": ('setup.cfg', self.autodoc) + } + + self.distr.command_options["build_sphinx"]["builder"] = ( + "command line", "builder1,builder2") + + build_doc = packaging.LocalBuildDoc(self.distr) + build_doc.finalize_options() + + self.assertEqual(["builder1", "builder2"], build_doc.builders) + class ParseRequirementsTest(base.BaseTestCase): |