mirror of
https://github.com/wassname/optuna-dashboard.git
synced 2026-08-20 12:40:54 +08:00
49 lines
1.6 KiB
Python
49 lines
1.6 KiB
Python
# 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
|
|
import os
|
|
import sys
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "Optuna Dashboard"
|
|
copyright = "2023, Optuna Dashboard Contributors"
|
|
author = "Optuna Dashboard Contributors."
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
SOURCE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__name__)))
|
|
sys.path.insert(0, SOURCE_DIR)
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.napoleon",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
autosummary_generate = True
|
|
autodoc_typehints = "description"
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"inherited-members": True,
|
|
"exclude-members": "with_traceback",
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_options = {"logo_only": True, "navigation_with_keys": True}
|
|
html_static_path = ["_static"]
|
|
html_favicon = "_static/favicon.ico"
|
|
html_logo = "_static/optuna-logo.png"
|
|
html_css_files = ["css/custom.css"]
|