d4e4efd779
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 |
||
|---|---|---|
| .. | ||
| testpackage | ||
| __init__.py | ||
| base.py | ||
| test_commands.py | ||
| test_core.py | ||
| test_files.py | ||
| test_hooks.py | ||
| test_integration.py | ||
| test_packaging.py | ||
| test_pbr_json.py | ||
| test_setup.py | ||
| test_util.py | ||
| test_version.py | ||
| test_wsgi.py | ||
| util.py | ||