[docs] Add favicon for website and docs

Author: Breakthrough

dist/generate_assets.py

@@ -48,6 +48,11 @@ class LogoOutput(NamedTuple):
 
 # Heights match the natural SVG aspect ratio (1024x480).
 # _small outputs use the -bg variant (background included).
+FAVICON_OUTPUTS: list[Path] = [
+    REPO_DIR / "docs" / "_static" / "favicon.ico",
+    REPO_DIR / "website" / "pages" / "img" / "favicon.ico",
+]
+
 LOGO_OUTPUTS: list[LogoOutput] = [
     LogoOutput(REPO_DIR / "docs" / "_static" / "pyscenedetect_logo.png", 900, 422, LOGO_SVG),
     LogoOutput(REPO_DIR / "docs" / "_static" / "pyscenedetect_logo_small.png", 300, 141, LOGO_BG_SVG),
@@ -165,6 +170,10 @@ def main():
         images[-1].save(ICO_PATH, format="ICO", append_images=images[:-1])
 
     print(f"Output ICO: {ICO_PATH}")
+    print("Copying favicons...")
+    for dest in FAVICON_OUTPUTS:
+        shutil.copy2(ICO_PATH, dest)
+        print(f"  {dest.relative_to(REPO_DIR)}")
     render_logos(inkscape)
 
 

docs/_static/favicon.ico

@@ -78,6 +78,7 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 html_css_files = ["pyscenedetect.css"]
+html_favicon = "favicon.ico"
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

docs/conf.py

@@ -12,6 +12,7 @@ copyright: 'Copyright © 2014-2024 Brandon Castellano.  All rights reserved.
 theme:
     name: readthedocs
     logo: img/pyscenedetect_logo_small.png
+    favicon: img/favicon.ico
     custom_dir: overrides
 # TODO: deprecated option for this theme
 google_analytics: ['UA-72551323-1', 'auto']