Skip to content

Add an --outdated flag to the build_docs.py script, which sets the 'outdated' value within HTML templates. #86

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
leonardr wants to merge 2 commits into from
Closed

Add an --outdated flag to the build_docs.py script, which sets the 'outdated' value within HTML templates. #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5d3f71
Add an --outdated flag to the build_docs.py script, which sets the 'o…
leonardr Apr 11, 2020
a36bc96
Remove support for the --outdated command-line argument.
leonardr Apr 18, 2020
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
23 changes: 14 additions & 9 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Usage:

build_docs.py [-h] [-d] [-q] [-b 3.7] [-r BUILD_ROOT] [-w WWW_ROOT]
build_docs.py [-h] [-d] [-q] [-o] [-b 3.7] [-r BUILD_ROOT] [-w WWW_ROOT]
[--skip-cache-invalidation] [--group GROUP] [--git]
[--log-directory LOG_DIRECTORY]
[--languages [fr [fr ...]]]
Expand Down Expand Up @@ -52,12 +52,12 @@
VERSION = "19.0"

BRANCHES = [
# version, git branch, isdev
(3.6, "3.6", False),
(3.7, "3.7", False),
(3.8, "3.8", True),
(3.9, "master", True),
(2.7, "2.7", False),
# version, git branch, isdev, outdated
(3.6, "3.6", False, False),
(3.7, "3.7", False, False),
(3.8, "3.8", True, False),
(3.9, "master", True, False),
(2.7, "2.7", False, True),
]

LANGUAGES = ["en", "fr", "ja", "ko", "pt-br", "zh-cn", "zh-tw", "id"]
Expand Down Expand Up @@ -223,6 +223,7 @@ def build_one(
group="docs",
log_directory="/var/log/docsbuild/",
language=None,
outdated=False,
):
if not language:
language = "en"
Expand All @@ -236,6 +237,8 @@ def build_one(
logging.info("Build start for version: %s, language: %s", str(version), language)
sphinxopts = SPHINXOPTS[language].copy()
sphinxopts.extend(["-q"])
if outdated:
sphinxopts.extend(["-A outdated=1"])
if language != "en":
gettext_language_tag = pep_545_tag_to_gettext_tag(language)
locale_dirs = os.path.join(build_root, str(version), "locale")
Expand Down Expand Up @@ -514,7 +517,8 @@ def main():
logging.root.setLevel(logging.DEBUG)
venv = os.path.join(args.build_root, "venv")
if args.branch:
branches_to_do = [(args.branch, str(args.branch), args.devel)]
branches_to_do = [(args.branch, str(args.branch), args.devel,
False)]
else:
branches_to_do = BRANCHES
if not args.languages:
Expand All @@ -524,7 +528,7 @@ def main():
args.languages = LANGUAGES
with ProcessPoolExecutor(max_workers=args.jobs) as executor:
futures = []
for version, git_branch, devel in branches_to_do:
for version, git_branch, devel, outdated in branches_to_do:
for language in args.languages:
futures.append(
(
Expand All @@ -541,6 +545,7 @@ def main():
args.group,
args.log_directory,
language,
outdated,
),
)
)
Expand Down