59 lines
1.6 KiB
Python
59 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
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "FanSAR"
|
|
copyright = "2023, Fancy"
|
|
author = "Fancy"
|
|
release = "v1.0"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"myst_nb",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.todo",
|
|
]
|
|
source_suffix = {
|
|
".rst": "restructuredtext",
|
|
".md": "markdown",
|
|
".ipynb": "myst-nb",
|
|
}
|
|
|
|
# templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
|
|
# to disable execution of notebooks
|
|
nb_execution_mode = "off"
|
|
nb_execution_excludepatterns = ["quickstart.ipynb"]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
# html_static_path = ['_static']
|
|
|
|
# General information about the project.
|
|
project = "faninsar"
|
|
copyright = "2023, Fancy"
|
|
author = "Chengyan Fan"
|
|
|
|
video_enforce_extra_source = True
|
|
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"undoc-members": True,
|
|
"member-order": "bysource",
|
|
"special-members": "__init__",
|
|
":show-inheritance:": True,
|
|
}
|