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.

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

Use pathlib more #197

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Use pathlib more #197

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1611b6
Use pathlib more
AA-Turner Sep 23, 2024
dfccf13
Merge branch 'main' into pathlib
AA-Turner Sep 23, 2024
de57082
Formatting
AA-Turner Sep 23, 2024
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
80 changes: 35 additions & 45 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

"""

from __future__ import annotations

from argparse import ArgumentParser
from collections.abc import Sequence
from contextlib import suppress, contextmanager
Expand Down Expand Up @@ -171,19 +173,15 @@ def picker_label(self):
return f"pre ({self.name})"
return self.name

def setup_indexsidebar(self, versions, dest_path):
def setup_indexsidebar(self, versions: Sequence[Version], dest_path: Path):
"""Build indexsidebar.html for Sphinx."""
with open(
HERE / "templates" / "indexsidebar.html", encoding="UTF-8"
) as sidebar_template_file:
sidebar_template = jinja2.Template(sidebar_template_file.read())
with open(dest_path, "w", encoding="UTF-8") as sidebar_file:
sidebar_file.write(
sidebar_template.render(
current_version=self,
versions=versions[::-1],
)
)
template_path = HERE / "templates" / "indexsidebar.html"
template = jinja2.Template(template_path.read_text(encoding="UTF-8"))
rendered_template = template.render(
current_version=self,
versions=versions[::-1],
)
dest_path.write_text(rendered_template, encoding="UTF-8")

@classmethod
def from_json(cls, name, values):
Expand Down Expand Up @@ -374,19 +372,17 @@ def setup_switchers(
languages_map = dict(sorted((l.tag, l.name) for l in languages if l.in_prod))
versions_map = {v.name: v.picker_label for v in reversed(versions)}

with open(
HERE / "templates" / "switchers.js", encoding="UTF-8"
) as switchers_template_file:
template = Template(switchers_template_file.read())
switchers_template_file = HERE / "templates" / "switchers.js"
switchers_path = html_root / "_static" / "switchers.js"
switchers_path.write_text(
template.safe_substitute(
LANGUAGES=json.dumps(languages_map),
VERSIONS=json.dumps(versions_map),
),
encoding="UTF-8",

template = Template(switchers_template_file.read_text(encoding="UTF-8"))
rendered_template = template.safe_substitute(
LANGUAGES=json.dumps(languages_map),
VERSIONS=json.dumps(versions_map),
)
for file in Path(html_root).glob("**/*.html"):
switchers_path.write_text(rendered_template, encoding="UTF-8")

for file in html_root.glob("**/*.html"):
depth = len(file.relative_to(html_root).parts) - 1
src = f"{'../' * depth}_static/switchers.js"
script = f' <script type="text/javascript" src="{src}"></script>\n'
Expand All @@ -411,15 +407,13 @@ def build_robots_txt(
if not www_root.exists():
logging.info("Skipping robots.txt generation (www root does not even exist).")
return
robots_file = www_root / "robots.txt"
with open(HERE / "templates" / "robots.txt", encoding="UTF-8") as template_file:
template = jinja2.Template(template_file.read())
with open(robots_file, "w", encoding="UTF-8") as robots_txt_file:
robots_txt_file.write(
template.render(languages=languages, versions=versions) + "\n"
)
robots_file.chmod(0o775)
run(["chgrp", group, robots_file])
template_path = HERE / "templates" / "robots.txt"
template = jinja2.Template(template_path.read_text(encoding="UTF-8"))
rendered_template = template.render(languages=languages, versions=versions)
robots_path = www_root / "robots.txt"
robots_path.write_text(rendered_template + "\n", encoding="UTF-8")
robots_path.chmod(0o775)
run(["chgrp", group, robots_path])
if not skip_cache_invalidation:
purge(http, "robots.txt")

Expand All @@ -431,14 +425,13 @@ def build_sitemap(
if not www_root.exists():
logging.info("Skipping sitemap generation (www root does not even exist).")
return
with open(HERE / "templates" / "sitemap.xml", encoding="UTF-8") as template_file:
template = jinja2.Template(template_file.read())
sitemap_file = www_root / "sitemap.xml"
sitemap_file.write_text(
template.render(languages=languages, versions=versions) + "\n", encoding="UTF-8"
)
sitemap_file.chmod(0o664)
run(["chgrp", group, sitemap_file])
template_path = HERE / "templates" / "sitemap.xml"
template = jinja2.Template(template_path.read_text(encoding="UTF-8"))
rendered_template = template.render(languages=languages, versions=versions)
sitemap_path = www_root / "sitemap.xml"
sitemap_path.write_text(rendered_template + "\n", encoding="UTF-8")
sitemap_path.chmod(0o664)
run(["chgrp", group, sitemap_path])


def build_404(www_root: Path, group):
Expand Down Expand Up @@ -867,10 +860,7 @@ def copy_build_to_webroot(self, http: urllib3.PoolManager) -> None:
[
"cp",
"-a",
*[
str(dist)
for dist in (Path(self.checkout) / "Doc" / "dist").glob("*")
],
*(self.checkout / "Doc" / "dist").glob("*"),
target / "archives",
]
Comment on lines 860 to 865
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

run() calls str() on each item of the command list, no need to duplicate here.

)
Expand Down Expand Up @@ -972,7 +962,7 @@ def symlink(
directory_path = path / directory
if not directory_path.exists():
return # No touching link, dest doc not built yet.
if link.exists() and readlink(str(link)) == directory:
if link.exists() and readlink(link) == directory:
return # Link is already pointing to right doc.
if link.exists():
link.unlink()
Expand Down