Merge "Stop building man pages by default"

This commit is contained in:
Jenkins 2017-04-15 15:00:46 +00:00 committed by Gerrit Code Review
commit ca6e92c723
3 changed files with 8 additions and 7 deletions

View File

@ -380,6 +380,12 @@ documentation`__. In addition, the ``autodoc_index_modules``,
``autodoc_tree_excludes`` options in the ``pbr`` section will affect the output
of the automatic module documentation generation.
.. versionchanged:: 3.0
The ``build_sphinx`` plugin used to default to building both HTML and man
page output. This is no longer the case, and you should explicitly set
``builders`` to ``html man`` if you wish to retain this behavior.
__ http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html
__ http://www.sphinx-doc.org/en/stable/setuptools.html

View File

@ -63,7 +63,7 @@ def _find_modules(arg, dirname, files):
class LocalBuildDoc(setup_command.BuildDoc):
builders = ['html', 'man']
builders = ['html']
command_name = 'build_sphinx'
sphinx_initialized = False
@ -142,10 +142,6 @@ class LocalBuildDoc(setup_command.BuildDoc):
self.builder_target_dir, self.doctree_dir,
self.builder, confoverrides, status_stream,
freshenv=self.fresh_env, warningiserror=self.warning_is_error)
sphinx_config = app.config
if self.builder == 'man' and len(
getattr(sphinx_config, 'man_pages', '')) == 0:
return
self.sphinx_initialized = True
try:

View File

@ -308,9 +308,8 @@ class BuildSphinxTest(BaseSphinxTest):
build_doc = packaging.LocalBuildDoc(self.distr)
build_doc.finalize_options()
self.assertEqual(2, len(build_doc.builders))
self.assertEqual(1, len(build_doc.builders))
self.assertIn('html', build_doc.builders)
self.assertIn('man', build_doc.builders)
build_doc = packaging.LocalBuildDoc(self.distr)
build_doc.builders = ''