from __future__ import annotations
import argparse
import importlib.metadata
import json
import os
import shutil
import subprocess
from collections.abc import Generator
from contextlib import contextmanager
from pathlib import Path
from typing import TYPE_CHECKING, TypedDict, cast
if TYPE_CHECKING:
from collections.abc import Generator
REDIRECT_TEMPLATE = """
Page Redirection
You are being redirected. If this does not work, click this link
"""
parser = argparse.ArgumentParser()
parser.add_argument("--version", required=False)
parser.add_argument("output")
class VersionSpec(TypedDict):
versions: list[str]
latest: str
@contextmanager
def checkout(branch: str, skip: bool = False) -> Generator[None]:
if not skip:
subprocess.run(["git", "checkout", branch], check=True) # noqa: S603, S607
yield
if not skip:
subprocess.run(["git", "checkout", "-"], check=True) # noqa: S607
def load_version_spec() -> VersionSpec:
versions_file = Path("docs/_static/versions.json")
if versions_file.exists():
return cast("VersionSpec", json.loads(versions_file.read_text()))
return {"versions": [], "latest": ""}
def build(output_dir: str, version: str | None) -> None:
if version is None:
version = importlib.metadata.version("advanced_alchemy").rsplit(".")[0]
else:
os.environ["_ADVANCED_ALCHEMY_DOCS_BUILD_VERSION"] = version
subprocess.run(["make", "docs"], check=True) # noqa: S607
Path(output_dir).mkdir(exist_ok=True, parents=True)
Path(output_dir).joinpath(".nojekyll").touch(exist_ok=True)
version_spec = load_version_spec()
is_latest = version == version_spec["latest"]
docs_src_path = Path("docs/_build/html")
Path(output_dir).joinpath("index.html").write_text(REDIRECT_TEMPLATE.format(target="latest"))
if is_latest:
shutil.copytree(docs_src_path, Path(output_dir) / "latest", dirs_exist_ok=True)
shutil.copytree(docs_src_path, Path(output_dir) / version, dirs_exist_ok=True)
# copy existing versions into our output dir to preserve them when cleaning the branch
with checkout("gh-pages", skip=True):
for other_version in [*version_spec["versions"], "latest"]:
other_version_path = Path(other_version)
other_version_target_path = Path(output_dir) / other_version
if other_version_path.exists() and not other_version_target_path.exists():
shutil.copytree(other_version_path, other_version_target_path)
def main() -> None:
args = parser.parse_args()
build(output_dir=args.output, version=args.version)
if __name__ == "__main__":
main()