110 lines
3.2 KiB
Python
110 lines
3.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
import sys
|
|
from datetime import datetime
|
|
from pygments.styles.friendly import FriendlyStyle
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
FriendlyStyle.background_color = "#f3f2f1"
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'xtaothon'
|
|
project_copyright = f'2020-{datetime.now().year}, xtao-labs'
|
|
author = 'xtao-labs'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '1.21.1'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx_copybutton",
|
|
"sphinx_tabs.tabs"
|
|
]
|
|
|
|
master_doc = "index"
|
|
source_suffix = ".rst"
|
|
autodoc_member_order = "bysource"
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'zh_CN'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = ["_themes", ]
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
napoleon_use_rtype = False
|
|
|
|
pygments_style = "friendly"
|
|
|
|
copybutton_prompt_text = "$ "
|
|
|
|
html_title = "Xtaothon Documentation"
|
|
html_show_sourcelink = True
|
|
html_show_copyright = False
|
|
html_theme_options = {
|
|
"canonical_url": "https://docs.xtaolabs.com/",
|
|
"collapse_navigation": True,
|
|
"sticky_navigation": False,
|
|
"logo_only": True,
|
|
"display_version": True,
|
|
"style_external_links": True,
|
|
}
|
|
|
|
napoleon_use_param = False
|
|
|
|
html_logo = "_images/xtaothon.png"
|
|
html_favicon = "_images/favicon.ico"
|
|
|
|
latex_engine = "xelatex"
|
|
latex_logo = "_images/xtaothon.png"
|
|
|
|
latex_elements = {
|
|
"pointsize": "12pt",
|
|
"fontpkg": r"""
|
|
\setmainfont{Open Sans}
|
|
\setsansfont{Bitter}
|
|
\setmonofont{Ubuntu Mono}
|
|
"""
|
|
} |