Close sphinx-doc#9524: test: SphinxTestApp can take outdir as an …

…argument
tk0miya · Aug 14, 2021 · 3a53e02 · 3a53e02
1 parent 29d0205
commit 3a53e02
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/CHANGES b/CHANGES
@@ -19,6 +19,7 @@ Features added
   template variable ``sphinx_version_tuple``
 * #9445: py domain: ``:py:property:`` directive supports ``:classmethod:``
   option to describe the class property
+* #9524: test: SphinxTestApp can take ``outdir`` as an argument
 
 Bugs fixed
 ----------

diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py
@@ -102,23 +102,26 @@ class SphinxTestApp(application.Sphinx):
     _status: StringIO = None
     _warning: StringIO = None
 
-    def __init__(self, buildername: str = 'html', srcdir: path = None, freshenv: bool = False,
-                 confoverrides: Dict = None, status: IO = None, warning: IO = None,
-                 tags: List[str] = None, docutilsconf: str = None, parallel: int = 0) -> None:
+    def __init__(self, buildername: str = 'html', srcdir: path = None, outdir: path = None,
+                 freshenv: bool = False, confoverrides: Dict = None, status: IO = None,
+                 warning: IO = None, tags: List[str] = None, docutilsconf: str = None,
+                 parallel: int = 0) -> None:
 
         if docutilsconf is not None:
             (srcdir / 'docutils.conf').write_text(docutilsconf)
 
-        builddir = srcdir / '_build'
         confdir = srcdir
-        outdir = builddir.joinpath(buildername)
-        outdir.makedirs(exist_ok=True)
-        doctreedir = builddir.joinpath('doctrees')
-        doctreedir.makedirs(exist_ok=True)
         if confoverrides is None:
             confoverrides = {}
         warningiserror = False
 
+        if outdir is None:
+            outdir = srcdir / '_build' / buildername
+
+        outdir.makedirs(exist_ok=True)
+        doctreedir = outdir / 'doctrees'
+        doctreedir.makedirs(exist_ok=True)
+
         self._saved_path = sys.path[:]
         self._saved_directives = directives._directives.copy()  # type: ignore
         self._saved_roles = roles._roles.copy()  # type: ignore