chore(docs): add favicon (#399)

* chore(docs): add favicon

* fix(docs): typo

CHANGELOG.md

@@ -23,6 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   to not move the info window.
   [#389](https://github.com/jeertmans/manim-slides/pull/389)
 
+(unreleased-chore)=
+### Chore
+
+- Created a favicon for the website/documentation.
+  [#399](https://github.com/jeertmans/manim-slides/pull/399)
+
 (v5.1.3)=
 ## [v5.1.3](https://github.com/jeertmans/manim-slides/compare/v5.1.2...v5.1.3)
 
@@ -93,7 +99,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 (v5.1-chore)=
 ### Chore
 
-- Removed subrocess calls to FFMPEG with direct `libav` bindings using
+- Removed subrocess calls to FFmpeg with direct `libav` bindings using
   the `av` Python module. This should enhance rendering speed and security.
   [#335](https://github.com/jeertmans/manim-slides/pull/335)
 - Changed build backend to PDM and reflected on docs.

docs/source/_static/favicon.png

@@ -0,0 +1 @@
+../../../static/favicon.png

docs/source/conf.py

@@ -55,6 +55,7 @@ add_module_names = False
 
 html_theme = "furo"
 html_static_path = ["_static"]
+html_favicon = "_static/favicon.png"
 
 html_theme_options = {
     "light_logo": "logo_light_transparent.png",

static/logo.py

@@ -51,3 +51,28 @@ class ManimSlidesLogo(Scene):
         )  # order matters
         logo.move_to(ORIGIN)
         self.add(logo)
+
+
+class ManimSlidesFavicon(Scene):
+    def construct(self):
+        tex_template = TexTemplate()
+        tex_template.add_to_preamble(r"\usepackage{graphicx}\usepackage{fontawesome5}")
+        fill_color = "#c9d1d9"
+        stroke_color = "#343434"
+        play = Tex(
+            r"\faStepBackward\faStepForward",
+            fill_color=fill_color,
+            stroke_color=stroke_color,
+            tex_template=tex_template,
+        ).scale(4)
+        comment = Tex(
+            r"\reflectbox{\faComment*[regular]}",
+            fill_color=fill_color,
+            stroke_color=stroke_color,
+            tex_template=tex_template,
+        ).scale(9)
+        comment.move_to(play)
+        comment.shift(0.4 * DOWN)
+        favicon = VGroup(comment, play).scale(3)
+        favicon.move_to(ORIGIN)
+        self.add(favicon)

static/make_favicon.sh

@@ -0,0 +1,5 @@
+#! /bin/bash
+
+pdm run manim-slides render -t -qk -s --format png --resolution 64,64 static/logo.py ManimSlidesFavicon && mv media/images/logo/*.png static/favicon.png
+
+ln -f -r -s static/favicon.png docs/source/_static/favicon.png

static/make_logo.sh

@@ -1,21 +1,21 @@
 #! /bin/bash
 
-MANIM_SLIDES_THEME=light pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo.png
+MANIM_SLIDES_THEME=light pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py ManimSlidesLogo && mv media/images/logo/*.png static/logo.png
 
 ln -f -r -s static/logo.png docs/source/_static/logo.png
 
-MANIM_SLIDES_THEME=dark_docs pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_docs.png
+MANIM_SLIDES_THEME=dark_docs pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py ManimSlidesLogo && mv media/images/logo/*.png static/logo_dark_docs.png
 
 ln -f -r -s static/logo_dark_docs.png docs/source/_static/logo_dark_docs.png
 
-MANIM_SLIDES_THEME=dark_github pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_github.png
+MANIM_SLIDES_THEME=dark_github pdm run manim-slides render -qk -s --format png --resolution 2560,1280 static/logo.py ManimSlidesLogo && mv media/images/logo/*.png static/logo_dark_github.png
 
 ln -f -r -s static/logo_dark_github.png docs/source/_static/logo_dark_github.png
 
-MANIM_SLIDES_THEME=light pdm run manim-slides render -t -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_light_transparent.png
+MANIM_SLIDES_THEME=light pdm run manim-slides render -t -qk -s --format png --resolution 2560,1280 static/logo.py ManimSlidesLogo && mv media/images/logo/*.png static/logo_light_transparent.png
 
 ln -f -r -s static/logo_light_transparent.png docs/source/_static/logo_light_transparent.png
 
-MANIM_SLIDES_THEME=dark_docs pdm run manim-slides render -t -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_transparent.png
+MANIM_SLIDES_THEME=dark_docs pdm run manim-slides render -t -qk -s --format png --resolution 2560,1280 static/logo.py ManimSlidesLogo && mv media/images/logo/*.png static/logo_dark_transparent.png
 
 ln -f -r -s static/logo_dark_transparent.png docs/source/_static/logo_dark_transparent.png