Update docs with favicon and new left bar logo and title (camel-ai#687)

jimmy-neu · Jun 28, 2024 · dd52688 · dd52688
1 parent 5fe7c90
commit dd52688
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,6 +29,10 @@
 author = 'CAMEL-AI.org'
 release = '0.1.5.4'
 
+html_favicon = (
+ 'https://raw.githubusercontent.com/camel-ai/camel/master/misc/favicon.png'
+)
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
@@ -51,3 +55,11 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'sphinx_book_theme'
+
+html_theme_options = {
+ "logo": {
+ "text": f"CAMEL {release}",
+ "image_light": "https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png",
+ "image_dark": "https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png",
+ }
+}