AMMICO/docs/source/conf.py
Inga Ulusoy 65531c6204
minor changes for revision 2 (#212)
* fix typos

* add buttons for google colab everywhere

* update readme, separate out FAQ

* add privacy disclosure statement

* do not install using uv

* update docs notebook

* explicit install of libopenblas

* explicit install of libopenblas

* explicit install of libopenblas

* try to get scipy installed using uv

* use ubuntu 24.04

* go back to pip

* try with scipy only

* try with a few others

* use hatchling

* wording changes, install all requirements

* fix offending spacy version

* run all tests

* include faq in documentation, fix link

* make readme links point to documentation

* load model safely

* correct edit on GH link and bump version

* remove comments
2024-10-08 10:00:31 +02:00

46 строки
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
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.2.2"
# -- 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
nbsphinx_execute = "never"
napoleon_custom_sections = [("Returns", "params_style")]
myst_heading_anchors = 3
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "ssciwr", # Username
"github_repo": "AMMICO", # Repo name
"github_version": "main", # Version
"conf_py_path": "/docs/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"]