This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10685

packaging: move documentation HTML building to own function
ClosedPublic

Authored by indygreg on May 6 2021, 8:00 PM.

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG41be7698a4fd: packaging: move documentation HTML building to own function
Summary

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

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.May 6 2021, 8:00 PM
baymax updated this revision to Diff 27756.May 7 2021, 11:30 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 27793.May 10 2021, 11:38 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

mharbison72 accepted this revision.May 10 2021, 11:47 PM
This revision is now accepted and ready to land.May 10 2021, 11:47 PM

Revision Contents
Changeset List

Diff 27944

contrib/packaging/hgpackaging/pyoxidizer.py

('lib/mercurial/templates/**/*', 'templates/'), ('lib/mercurial/templates/**/*', 'templates/'),
] ]
STAGING_EXCLUDES_WINDOWS = [ STAGING_EXCLUDES_WINDOWS = [
"doc/hg-ssh.8.html", "doc/hg-ssh.8.html",
] ]
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( def run_pyoxidizer(
source_dir: pathlib.Path, source_dir: pathlib.Path,
build_dir: pathlib.Path, build_dir: pathlib.Path,
out_dir: pathlib.Path, out_dir: pathlib.Path,
target_triple: str, target_triple: str,
): ):
"""Build Mercurial with PyOxidizer and copy additional files into place. """Build Mercurial with PyOxidizer and copy additional files into place.
# Now assemble all the files from PyOxidizer into the staging directory. # Now assemble all the files from PyOxidizer into the staging directory.
shutil.copytree(build_dir, out_dir) shutil.copytree(build_dir, out_dir)
# Move some of those files around. We can get rid of this once Mercurial # Move some of those files around. We can get rid of this once Mercurial
# is taught to use the importlib APIs for reading resources. # is taught to use the importlib APIs for reading resources.
process_install_rules(STAGING_RULES_APP, build_dir, out_dir) process_install_rules(STAGING_RULES_APP, build_dir, out_dir)
# We also need to run setup.py build_doc to produce html files, build_docs_html(source_dir)
# 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,
)
if "windows" in target_triple: if "windows" in target_triple:
process_install_rules(STAGING_RULES_WINDOWS, source_dir, out_dir) process_install_rules(STAGING_RULES_WINDOWS, source_dir, out_dir)
# Write out a default editor.rc file to configure notepad as the # Write out a default editor.rc file to configure notepad as the
# default editor. # default editor.
os.makedirs(out_dir / "defaultrc", exist_ok=True) os.makedirs(out_dir / "defaultrc", exist_ok=True)
with (out_dir / "defaultrc" / "editor.rc").open( with (out_dir / "defaultrc" / "editor.rc").open(