Browse Source

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
tags/3.0.1
Stephen Finucane 2 years ago
parent
commit
0469bf39d4
1 changed files with 3 additions and 0 deletions
  1. 3
    0
      pbr/builddoc.py

+ 3
- 0
pbr/builddoc.py View File

@@ -183,6 +183,9 @@ class LocalBuildDoc(setup_command.BuildDoc):
183 183
                         "autodoc_exclude_modules",
184 184
                         [None, ""])[1].split()))
185 185
 
186
+        # TODO(stephenfin): Deprecate this functionality once we depend on
187
+        # Sphinx 1.6, which includes a similar feature, in g-r
188
+        # https://github.com/sphinx-doc/sphinx/pull/3476
186 189
         for builder in self.builders:
187 190
             self.builder = builder
188 191
             self.finalize_options()

Loading…
Cancel
Save