# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1620315460 25200
# Node ID 41be7698a4fd56efe5edd79ad8aae685f21ac80e
# Parent  c8001d9c26f51b7ae9c12c2381bd22c0e49cd1bb
packaging: move documentation HTML building to own function

This is part of some light refactoring to enable us to use
PyOxidizer for WiX MSI installer generation.

Differential Revision: https://phab.mercurial-scm.org/D10685

diff -r c8001d9c26f5 -r 41be7698a4fd contrib/packaging/hgpackaging/pyoxidizer.py
--- a/contrib/packaging/hgpackaging/pyoxidizer.py	Thu May 06 16:04:24 2021 -0700
+++ b/contrib/packaging/hgpackaging/pyoxidizer.py	Thu May 06 08:37:40 2021 -0700
@@ -53,6 +53,21 @@
 ]
 
 
+def build_docs_html(source_dir: pathlib.Path):
+    """Ensures HTML documentation is built.
+
+    This will fail if docutils isn't available.
+
+    (The HTML docs aren't built as part of `pip install` so we need to build them
+    out of band.)
+    """
+    subprocess.run(
+        [sys.executable, str(source_dir / "setup.py"), "build_doc", "--html"],
+        cwd=str(source_dir),
+        check=True,
+    )
+
+
 def run_pyoxidizer(
     source_dir: pathlib.Path,
     build_dir: pathlib.Path,
@@ -113,14 +128,7 @@
     # is taught to use the importlib APIs for reading resources.
     process_install_rules(STAGING_RULES_APP, build_dir, out_dir)
 
-    # We also need to run setup.py build_doc to produce html files,
-    # as they aren't built as part of ``pip install``.
-    # This will fail if docutils isn't installed.
-    subprocess.run(
-        [sys.executable, str(source_dir / "setup.py"), "build_doc", "--html"],
-        cwd=str(source_dir),
-        check=True,
-    )
+    build_docs_html(source_dir)
 
     if "windows" in target_triple:
         process_install_rules(STAGING_RULES_WINDOWS, source_dir, out_dir)