FlagEmbedding/docs/source/conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys

sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("../.."))

project = 'FlagEmbedding'
copyright = '2024, BAAI'
author = 'BAAI'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "sphinx.ext.napoleon",
    "sphinx.ext.autodoc",
    "sphinx.ext.githubpages",
    "sphinx.ext.viewcode",
    "sphinx.ext.coverage",
    "sphinx_design",
    "myst_nb",
]

templates_path = ['_templates']
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# html_theme = 'furo'
html_theme = "pydata_sphinx_theme"
html_logo = "_static/img/bge-logo.jpeg"
html_title = "BGE"
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 = {
    "external_links": [
        {
            "url": "https://huggingface.co/collections/BAAI/bge-66797a74476eb1f085c7446d",
            "name": "HF Models",
        },
    ],
    "icon_links":[
        {
            "name": "GitHub",
            "url": "https://github.com/FlagOpen/FlagEmbedding",
            "icon": "fa-brands fa-github",
        },
        {
            "name": "PyPI",
            "url": "https://pypi.org/project/FlagEmbedding/",
            "icon": "fa-brands fa-python",
        },
        {
            "name": "HF Models",
            "url": "https://huggingface.co/collections/BAAI/bge-66797a74476eb1f085c7446d",
            "icon": "fa-solid fa-cube",
        }
    ],
    "header_links_before_dropdown": 5,
}

html_context = {
   "default_mode": "light"
}