зеркало из
https://github.com/ssciwr/AMMICO.git
synced 2025-11-03 23:46:04 +02:00
fe1e937f18
* Changed README.md * Changed docs notebooks --------- Co-authored-by: Inga Ulusoy <inga.ulusoy@uni-heidelberg.de>
44 строки
1.5 KiB
Python
44 строки
1.5 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
|
|
|
|
sys.path.insert(0, os.path.abspath("../../ammico/"))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "AMMICO"
|
|
copyright = "2022, Scientific Software Center, Heidelberg University"
|
|
author = "Scientific Software Center, Heidelberg University"
|
|
release = "0.0.1"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "myst_parser", "nbsphinx"]
|
|
nbsphinx_allow_errors = True
|
|
napoleon_custom_sections = [("Returns", "params_style")]
|
|
|
|
html_context = {
|
|
"display_github": True, # Integrate GitHub
|
|
"github_user": "ssciwr", # Username
|
|
"github_repo": "AMMICO", # Repo name
|
|
"github_version": "main", # Version
|
|
"conf_py_path": "/source/", # Path in the checkout to the docs root
|
|
}
|
|
|
|
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 = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|