Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow macOS installer builds to package pre-built html docs #20715

Merged
merged 2 commits into from
Jun 8, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
macOS installer build can now use pre-built html docs
build-installer now looks in its directory of source tarballs
for a suitable html tarball of the same version.  If so, it
will unpack and use it rather than rebuilding the html format
documentation set from the source repo.  This is intended as
a speedup for test builds of the installer.  Files names must
be in the same format as produced by the docs build for download,
for example, `python-3.9.0b1-docs-html.tar.bz2`.
  • Loading branch information
ned-deily committed Jun 8, 2020
commit e58530a3bf0d06d95c0d0a311b359676243fa2ff
40 changes: 33 additions & 7 deletions Mac/BuildScript/build-installer.py
Original file line number Diff line number Diff line change
Expand Up @@ -1066,14 +1066,40 @@ def buildPythonDocs():
curDir = os.getcwd()
os.chdir(buildDir)
runCommand('make clean')
# Create virtual environment for docs builds with blurb and sphinx
runCommand('make venv')
runCommand('venv/bin/python3 -m pip install -U Sphinx==2.2.0')
runCommand('make html PYTHON=venv/bin/python')

# Search third-party source directory for a pre-built version of the docs.
# Use the naming convention of the docs.python.org html downloads:
# python-3.9.0b1-docs-html.tar.bz2
doctarfiles = [ f for f in os.listdir(DEPSRC)
if f.startswith('python-'+getFullVersion())
if f.endswith('-docs-html.tar.bz2') ]
if doctarfiles:
doctarfile = doctarfiles[0]
if not os.path.exists('build'):
os.mkdir('build')
# if build directory existed, it was emptied by make clean, above
os.chdir('build')
# Extract the first archive found for this version into build
runCommand('tar xjf %s'%shellQuote(doctarfile))
# see if tar extracted a directory ending in -docs-html
archivefiles = [ f for f in os.listdir('.')
if f.endswith('-docs-html')
if os.path.isdir(f) ]
if archivefiles:
archivefile = archivefiles[0]
# make it our 'Docs/build/html' directory
print(' -- using pre-built python documentation from %s'%archivefile)
os.rename(archivefile, 'html')
os.chdir(buildDir)

htmlDir = os.path.join('build', 'html')
if not os.path.exists(htmlDir):
# Create virtual environment for docs builds with blurb and sphinx
runCommand('make venv')
runCommand('venv/bin/python3 -m pip install -U Sphinx==2.2.0')
runCommand('make html PYTHON=venv/bin/python')
os.rename(htmlDir, docdir)
os.chdir(curDir)
if not os.path.exists(docdir):
os.mkdir(docdir)
os.rename(os.path.join(buildDir, 'build', 'html'), docdir)


def buildPython():
Expand Down