update docs

FlagOpen · Jan 3, 2025 · 0498828 · 0498828
1 parent a995448
commit 0498828
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 16 deletions.
diff --git a/docs/source/_static/img/bge-logo.jpeg → docs/source/_static/img/bge_logo.jpeg b/docs/source/_static/img/bge-logo.jpeg → docs/source/_static/img/bge_logo.jpeg
diff --git a/docs/source/_static/img/bge_logo.jpg → docs/source/_static/img/bge_panda.jpg b/docs/source/_static/img/bge_logo.jpg → docs/source/_static/img/bge_panda.jpg
diff --git a/docs/source/bge/index.rst b/docs/source/bge/index.rst
@@ -1,6 +1,10 @@
 BGE
 ===
 
+.. figure:: ../_static/img/bge_logo.jpeg
+   :width: 250
+   :align: center
+
 **BGE** stands for **BAAI General Embeddings**, which is a series of embedding models released by BAAI.
 
 .. toctree::

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,7 +11,7 @@
 sys.path.insert(0, os.path.abspath(".."))
 sys.path.insert(0, os.path.abspath("../.."))
 
-project = 'FlagEmbedding'
+project = 'BGE'
 copyright = '2024, BAAI'
 author = 'BAAI'
 
@@ -36,24 +36,17 @@
 
 # html_theme = 'furo'
 html_theme = "pydata_sphinx_theme"
-html_logo = "_static/img/bge-logo.jpeg"
-html_title = "BGE"
+html_logo = "_static/img/bge_logo.jpeg"
 html_static_path = ['_static']
 html_css_files = ["css/custom.css"]
-html_theme_options = {
-    "light_logo": "_static/img/bge-logo.jpeg",
-    "dark_logo": "_static/img/bge-logo.jpeg",
-    # "logo": {
-    #     "text": "BGE",
-    #     "image_dark": "_static/img/bge-logo.jpeg",
-    # },
-    "navigation_depth": 5,
-}
 
 # MyST-NB conf
 nb_execution_mode = "off"
 
 html_theme_options = {
+    "logo": {
+        "text": "BGE",
+    },
     "external_links": [
         {
             "url": "https://huggingface.co/collections/BAAI/bge-66797a74476eb1f085c7446d",
@@ -77,6 +70,7 @@
             "icon": "fa-solid fa-cube",
         }
     ],
+    "navigation_depth": 5,
     "header_links_before_dropdown": 5,
 }
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,12 +6,12 @@
 :html_theme.sidebar_secondary.remove: True
 
 
-BGE
-===
+Welcome to BGE!
+===============
 
-Welcome to BGE documentation!
+.. Welcome to BGE documentation!
 
-.. figure:: _static/img/bge_logo.jpg
+.. figure:: _static/img/bge_panda.jpg
    :width: 400
    :align: center