From 4b8821a219450984d590c3cbd446105af3378b3a Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Thu, 24 Oct 2024 14:37:35 -0500 Subject: [PATCH] docs: delete unneeded file --- build_docs.py | 89 --------------------------------------------------- 1 file changed, 89 deletions(-) delete mode 100644 build_docs.py diff --git a/build_docs.py b/build_docs.py deleted file mode 100644 index 8e884a4e..00000000 --- a/build_docs.py +++ /dev/null @@ -1,89 +0,0 @@ -import os -import shutil -import subprocess -from pathlib import Path - -REDIRECT_HTML = """ - - -Redirecting... - -""" -DOCS_BUILD_PATH = Path("docs/_build/silverback") -LATEST_PATH = DOCS_BUILD_PATH / "latest" -STABLE_PATH = DOCS_BUILD_PATH / "stable" - - -class ApeDocsBuildError(Exception): - pass - - -def git(*args): - return subprocess.check_output(["git", *args]).decode("ascii").strip() - - -def new_dir(path: Path) -> Path: - if path.exists(): - shutil.rmtree(path) - - path.mkdir(parents=True) - return path - - -def build_docs(path: Path) -> Path: - path = new_dir(path) - - try: - subprocess.check_call(["sphinx-build", "docs", str(path)]) - except subprocess.SubprocessError as err: - raise ApeDocsBuildError(f"Command 'sphinx-build docs {path}' failed.") from err - - return path - - -def main(): - """ - There are three GH events we build for: - - 1. Push to main: we build into 'latest/'. - The GH action will commit these changes to the 'gh-pages' branch. - - 2. Release: we copy 'latest/' into the release dir, as well as to 'stable/'. - The GH action will commit these changes to the 'gh-pages' branch. - - 3. Pull requests or local development: We ensure a successful build. - """ - - event_name = os.environ.get("GITHUB_EVENT_NAME") - is_ephemeral = event_name in ["pull_request", None] - - if event_name == "push" or is_ephemeral: - build_docs(LATEST_PATH) - elif event_name == "release": - tag = git("describe", "--tag") - if not tag: - raise ApeDocsBuildError("Unable to find release tag.") - - if "beta" not in tag and "alpha" not in tag: - build_dir = DOCS_BUILD_PATH / tag - build_docs(build_dir) - - # Clean-up unnecessary extra 'fonts/' directories to save space. - # There should still be one in 'latest/' - for font_dirs in build_dir.glob("**/fonts"): - if font_dirs.exists(): - shutil.rmtree(font_dirs) - - shutil.copytree(build_dir, STABLE_PATH) - else: - build_docs(STABLE_PATH) - - # Set up the redirect at /index.html - DOCS_BUILD_PATH.mkdir(exist_ok=True, parents=True) - with open(DOCS_BUILD_PATH / "index.html", "w") as f: - redirect = "latest" if is_ephemeral else "stable" - f.write(REDIRECT_HTML.format(redirect)) - - -if __name__ == "__main__": - main()