# 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 # . = /doc/source # sys.path.insert(0, os.path.abspath('./csst_common/')) # sys.path.insert(0, os.path.abspath('../../')) sys.path.append(os.path.abspath('./csst_common/')) # -- Project information ----------------------------------------------------- project = 'A Guide for CSST DAS Developers' copyright = '2022, CSST DAS Team' author = 'CSST DAS Team' # The full version, including alpha/beta/rc tags release = '0.0.1alpha' # -- 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 = ["recommonmark", "sphinx_copybutton", "sphinx_togglebutton", # "sphinx_exec_code", "sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.viewcode", "sphinx.ext.mathjax", ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # 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' # 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'] # -- Support Chinese ------------------------------------------------------- # latex_engine = 'xelatex' # latex_use_xindy = False # latex_elements = { # 'preamble': '\\usepackage[UTF8]{ctex}\n', # } # -- Copy Button -------------------------------------------------------- # copybutton_exclude = ['.linenos']