Skip to content

Also build french documentation. #1

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.

Sign up for GitHub

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

Closed
JulienPalard wants to merge 1 commit into from
Closed

Also build french documentation. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
128 changes: 90 additions & 38 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import os
import subprocess
import sys
from shlex import quote


BUILDROOT = "/srv/docsbuild"
Expand All @@ -37,6 +38,19 @@
(BUILDROOT + "/python36", WWWROOT + "/3.6", True),
(BUILDROOT + "/python27", WWWROOT + "/2.7", False),
]

TRANSLATIONS = {
"fr": {'po_files_repo': 'https://github.com/AFPy/python_doc_fr.git',
'branches': [
# version, target, isdev
('3.4', WWWROOT + "/3.4", False),
('3.5', WWWROOT + "/3.5", False),
('3.6', WWWROOT + "/3.6", True),
('2.7', WWWROOT + "/2.7", False)
]
}
}

DEVGUIDE_CHECKOUT = BUILDROOT + "/devguide"
DEVGUIDE_TARGET = WWWROOT + "/devguide"

Expand All @@ -58,55 +72,49 @@ def _file_unchanged(old, new):
break
return True

def shell_out(cmd):
logging.debug("Running command %r", cmd)
try:
subprocess.check_output(cmd, shell=True, stdin=subprocess.PIPE, stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as e:
logging.error("command failed with output %r", e.output.decode("utf-8"))
raise

def build_one(checkout, target, isdev, quick):
logging.info("Doc autobuild started in %s", checkout)
os.chdir(checkout)

logging.info("Updating checkout")
shell_out("hg pull -u")

maketarget = "autobuild-" + ("html" if quick else ("dev" if isdev else "stable"))
logging.info("Running make %s", maketarget)
logname = os.path.basename(checkout) + ".log"
shell_out("cd Doc; make SPHINXBUILD=%s %s >> /var/log/docsbuild/%s 2>&1" %
(SPHINXBUILD, maketarget, logname))

logging.info("Computing changed files")
def changed_files(source, target):
changed = []
for dirpath, dirnames, filenames in os.walk("Doc/build/html/"):
dir_rel = dirpath[len("Doc/build/html/"):]
for dirpath, dirnames, filenames in os.walk(source):
dir_rel = dirpath[len(source):]
for fn in filenames:
local_path = os.path.join(dirpath, fn)
rel_path = os.path.join(dir_rel, fn)
target_path = os.path.join(target, rel_path)
if (os.path.exists(target_path) and
not _file_unchanged(target_path, local_path)):
changed.append(rel_path)
return changed


logging.info("Copying HTML files to %s", target)
shell_out("chown -R :docs Doc/build/html/")
shell_out("chmod -R o+r Doc/build/html/")
shell_out("find Doc/build/html/ -type d -exec chmod o+x {} ';'")
shell_out("cp -a Doc/build/html/* %s" % target)
def shell_out(cmd):
logging.debug("Running command %r", cmd)
try:
subprocess.check_output(cmd, shell=True, stdin=subprocess.PIPE, stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as e:
logging.error("command failed with output %r", e.output.decode("utf-8"))
raise

def copy_to_www(source, target, quick):
changed = changed_files(source, target)
logging.info("Copying HTML files from %s to %s",
quote(source), quote(target))
shell_out("chown -R :docs {}".format(quote(source)))
shell_out("chmod -R o+r {}".format(quote(source)))
shell_out("find {} -type d -exec chmod o+x {{}} ';'".format(quote(source)))
shell_out("mkdir -p {}".format(quote(target)))
shell_out("cp -a {}* {}".format(source, quote(target)))
if not quick:
logging.debug("Copying dist files")
shell_out("chown -R :docs Doc/dist/")
shell_out("chmod -R o+r Doc/dist/")
shell_out("mkdir -m o+rx -p %s/archives" % target)
shell_out("chown :docs %s/archives" % target)
shell_out("cp -a Doc/dist/* %s/archives" % target)
source_dist = source.replace('/build/html/', '/dist/')
shell_out("chown -R :docs {}".format(quote(source_dist)))
shell_out("chmod -R o+r {}".format(quote(source_dist)))
shell_out("mkdir -m o+rx -p {}/archives".format(quote(target)))
shell_out("chown :docs {}/archives".format(quote(target)))
shell_out("cp -a {}/* {}/archives".format(source_dist, quote(target)))
changed.append("archives/")
for fn in os.listdir(os.path.join(target, "archives")):
changed.append("archives/" + fn)

logging.info("%s files changed", len(changed))
if changed:
target_ino = os.stat(target).st_ino
Expand All @@ -120,8 +128,39 @@ def build_one(checkout, target, isdev, quick):
to_purge.extend(prefix + "/" + p for p in changed)
logging.info("Running CDN purge")
shell_out("curl -X PURGE \"https://docs.python.org/{%s}\"" % ",".join(to_purge))
logging.info("HTML copy from %s to %s finished", source, target)


def build_translation(git_repo, lang='fr', version='3.5', isdev=False,
quick=False):
source = "gen/src/{}/Doc/build/html/".format(version)
target = os.path.join(WWWROOT, lang, version)
lang_root = os.path.join(BUILDROOT, lang)
if not os.path.exists(lang_root):
shell_out("git clone {} {}".format(quote(git_repo), quote(lang_root)))
os.chdir(lang_root)
logging.info("Running make for translation %s version %s", lang, version)
logname = os.path.join("/var/log/docsbuild/" + lang + '-' + version + ".log")
maketarget = "autobuild-" + ("html" if quick else ("dev" if isdev else "stable"))
shell_out("make build MODE={} RELEASE={} >> {} 2>&1".format(
maketarget, quote(version), quote(logname)))
copy_to_www(source, target, quick)


def build_one(checkout, target, isdev, quick):
logging.info("Doc autobuild started in %s", checkout)
os.chdir(checkout)

logging.info("Updating checkout")
shell_out("hg pull -u")

maketarget = "autobuild-" + ("html" if quick else ("dev" if isdev else "stable"))
logging.info("Running make %s", maketarget)
logname = os.path.basename(checkout) + ".log"
shell_out("cd Doc; make SPHINXBUILD=%s %s >> /var/log/docsbuild/%s 2>&1" %
(SPHINXBUILD, maketarget, logname))
copy_to_www('Doc/build/html/', target, quick)

logging.info("Finished %s", checkout)

def build_devguide():
logging.info("Building devguide")
Expand All @@ -135,6 +174,7 @@ def usage():
print(" {} (to build all branches)".format(sys.argv[0]))
print("or")
print(" {} [-d] <checkout> <target>".format(sys.argv[0]))
print(" {} [-l] <lang> (to build all branches for a given language)".format(sys.argv[0]))
sys.exit(2)


Expand All @@ -148,22 +188,34 @@ def usage():
logging.root.setLevel(logging.DEBUG)

try:
opts, args = getopt.getopt(sys.argv[1:], "dq")
opts, args = getopt.getopt(sys.argv[1:], "dql:")
except getopt.error:
usage()
quick = devel = False
for opt, _ in opts:
quick = devel = lang = False
for opt, value in opts:
if opt == "-q":
quick = True
if opt == "-d":
devel = True
if opt == "-l":
lang = value
if devel and not args:
usage()
try:
if args:
if len(args) != 2:
usage()
build_one(os.path.abspath(args[0]), os.path.abspath(args[1]), devel, quick)
elif lang:
try:
po_files_repo = TRANSLATIONS[lang]['po_files_repo']
except KeyError:
print("Unknown lang")
sys.exit(1)
else:
for version, target, devel in TRANSLATIONS[lang]['branches']:
build_translation(po_files_repo,
lang, version, devel, quick)
else:
for checkout, dest, devel in BRANCHES:
build_one(checkout, dest, devel, quick)
Expand Down