Browse Source

Stop building man pages by default

From pretty much the beginning [1], pbr has defaulted to building both
man page and html output, but has failed to document it anywhere. People
tend to copy-paste their 'setup.py' and 'conf.py', or rely on the
'cookiecutter' project, with very little understanding of what's going
on under the hood (and why would you care - it's docs :)). This means
that the vast majority of folks using 'pbr' (basically everyone in
OpenStack) have been unwittingly building "man pages" as part of their
doc builds for no good reason, which has also led to a lot of confusion
when this magic behavior is the cause of bugs [2][3].

There's no good reason that pbr should default to building both man
pages and html output. For folks that want this functionality, we should
document it so they can use it. For everyone else though, let's do the
sane thing and output html like the standard 'build_sphinx' plugin.

[1] https://github.com/openstack-dev/pbr/commit/5b8b7f1d
[2] https://bugs.launchpad.net/pbr/+bug/1681983
[3] https://bugs.launchpad.net/oslotest/+bug/1379998

Change-Id: I579134a2b7980669180c1666503b848835cc2957
Closes-Bug: #1681983
tags/3.0.0^2
Stephen Finucane 2 years ago
parent
commit
d4e4efd779
3 changed files with 8 additions and 7 deletions
  1. 6
    0
      doc/source/index.rst
  2. 1
    5
      pbr/builddoc.py
  3. 1
    2
      pbr/tests/test_setup.py

+ 6
- 0
doc/source/index.rst View File

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

+ 1
- 5
pbr/builddoc.py View File

@@ -63,7 +63,7 @@ def _find_modules(arg, dirname, files):
63 63
 
64 64
 class LocalBuildDoc(setup_command.BuildDoc):
65 65
 
66
-    builders = ['html', 'man']
66
+    builders = ['html']
67 67
     command_name = 'build_sphinx'
68 68
     sphinx_initialized = False
69 69
 
@@ -142,10 +142,6 @@ class LocalBuildDoc(setup_command.BuildDoc):
142 142
             self.builder_target_dir, self.doctree_dir,
143 143
             self.builder, confoverrides, status_stream,
144 144
             freshenv=self.fresh_env, warningiserror=self.warning_is_error)
145
-        sphinx_config = app.config
146
-        if self.builder == 'man' and len(
147
-                getattr(sphinx_config, 'man_pages', '')) == 0:
148
-            return
149 145
         self.sphinx_initialized = True
150 146
 
151 147
         try:

+ 1
- 2
pbr/tests/test_setup.py View File

@@ -308,9 +308,8 @@ class BuildSphinxTest(BaseSphinxTest):
308 308
         build_doc = packaging.LocalBuildDoc(self.distr)
309 309
         build_doc.finalize_options()
310 310
 
311
-        self.assertEqual(2, len(build_doc.builders))
311
+        self.assertEqual(1, len(build_doc.builders))
312 312
         self.assertIn('html', build_doc.builders)
313
-        self.assertIn('man', build_doc.builders)
314 313
 
315 314
         build_doc = packaging.LocalBuildDoc(self.distr)
316 315
         build_doc.builders = ''

Loading…
Cancel
Save