From 0469bf39d4d7da071410f7a245f851abaf22af6a Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Wed, 1 Mar 2017 11:28:39 +0000
Subject: [PATCH] trivial: Add note about multiple builders support

Sphinx 1.6 will support the definition of multiple builders in a
setup.cfg file like so:

  [build_sphinx]
  builder = html man

Once we support this version of Sphinx, we should stop carrying the
custom versions of this tooling we use.

Upstreaming things FTW.

Change-Id: Ibf2a003229a4585df96b09da7ca547e201c5aef5
---
 pbr/builddoc.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pbr/builddoc.py b/pbr/builddoc.py
index 343f7c3c..45e782a5 100644
--- a/pbr/builddoc.py
+++ b/pbr/builddoc.py
@@ -183,6 +183,9 @@ 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
         for builder in self.builders:
             self.builder = builder
             self.finalize_options()