Skip to content

Extract switchers.js rendering into a new function. #280

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

Merged
merged 1 commit into from
Apr 12, 2025
Merged
Changes from all commits
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
40 changes: 25 additions & 15 deletions build_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -467,23 +467,13 @@ def edit(file: Path):
temporary.rename(file)


def setup_switchers(versions: Versions, languages: Languages, html_root: Path) -> None:
def setup_switchers(script_content: bytes, html_root: Path) -> None:
"""Setup cross-links between CPython versions:
- Cross-link various languages in a language switcher
- Cross-link various versions in a version switcher
"""
language_pairs = sorted((l.tag, l.switcher_label) for l in languages if l.in_prod) # NoQA: E741
version_pairs = [(v.name, v.picker_label) for v in reversed(versions)]

switchers_template_file = HERE / "templates" / "switchers.js"
switchers_path = html_root / "_static" / "switchers.js"

template = Template(switchers_template_file.read_text(encoding="UTF-8"))
rendered_template = template.safe_substitute(
LANGUAGES=json.dumps(language_pairs),
VERSIONS=json.dumps(version_pairs),
)
switchers_path.write_text(rendered_template, encoding="UTF-8")
switchers_path.write_text(script_content, encoding="UTF-8")

for file in html_root.glob("**/*.html"):
depth = len(file.relative_to(html_root).parts) - 1
Expand Down Expand Up @@ -541,8 +531,8 @@ class DocBuilder:
version: Version
versions: Versions
language: Language
languages: Languages
cpython_repo: Repository
switchers_content: bytes
build_root: Path
www_root: Path
select_output: Literal["no-html", "only-html", "only-html-en"] | None
Expand Down Expand Up @@ -697,7 +687,7 @@ def build(self) -> None:
run(["chgrp", "-R", self.group, self.log_directory])
if self.includes_html:
setup_switchers(
self.versions, self.languages, self.checkout / "Doc" / "build" / "html"
self.switchers_content, self.checkout / "Doc" / "build" / "html"
)
logging.info("Build done (%s).", format_seconds(perf_counter() - start_time))

Expand Down Expand Up @@ -1108,6 +1098,8 @@ def build_docs(args: argparse.Namespace) -> bool:
force_build = args.force
del args.force

switchers_content = render_switchers(versions, languages)

build_succeeded = set()
build_failed = set()
cpython_repo = Repository(
Expand All @@ -1127,7 +1119,12 @@ def build_docs(args: argparse.Namespace) -> bool:
scope.set_tag("language", language.tag)
cpython_repo.update()
builder = DocBuilder(
version, versions, language, languages, cpython_repo, **vars(args)
version,
versions,
language,
cpython_repo,
switchers_content,
**vars(args),
)
built_successfully = builder.run(http, force_build=force_build)
if built_successfully:
Expand Down Expand Up @@ -1179,6 +1176,19 @@ def parse_languages_from_config() -> Languages:
return Languages.from_json(config["defaults"], config["languages"])


def render_switchers(versions: Versions, languages: Languages) -> bytes:
language_pairs = sorted((l.tag, l.switcher_label) for l in languages if l.in_prod) # NoQA: E741
version_pairs = [(v.name, v.picker_label) for v in reversed(versions)]

switchers_template_file = HERE / "templates" / "switchers.js"
template = Template(switchers_template_file.read_text(encoding="UTF-8"))
rendered_template = template.safe_substitute(
LANGUAGES=json.dumps(language_pairs),
VERSIONS=json.dumps(version_pairs),
)
return rendered_template.encode("UTF-8")


def build_sitemap(
versions: Versions, languages: Languages, www_root: Path, group: str
) -> None:
Expand Down