|
- # 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
-
- project = "Fish Diffusion"
- copyright = "2023, Fish Audio Team"
- author = "Fish Audio Team"
-
- # -- General configuration ---------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
- extensions = [
- "sphinx.ext.autodoc",
- "sphinx.ext.viewcode",
- "sphinx.ext.todo",
- "sphinx.ext.napoleon",
- "myst_parser",
- ]
-
- templates_path = ["_templates"]
- exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-
- # -- Options for HTML output -------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
- html_theme = "furo"
- html_static_path = ["_static"]
- html_logo = (
- "https://cdn.jsdelivr.net/gh/fishaudio/fish-diffusion@main/images/logo_512x512.png"
- )
- html_favicon = html_logo
-
- html_css_files = [
- "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
- "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
- ]
-
- html_theme_options = {
- "announcement": "Wiki is under construction, we welcome any contribution!",
- "source_repository": "https://github.com/fishaudio/fish-diffusion/",
- "source_branch": "main",
- "source_directory": "docs/",
- "footer_icons": [
- {
- "name": "GitHub",
- "url": "https://github.com/fishaudio/fish-diffusion/",
- "html": "",
- "class": "fa-brands fa-github fa-2x",
- },
- ],
- }
|