1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
|
# 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 = 'acres'
copyright = '2025, The NiPreps Developers'
author = 'The NiPreps Developers'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'myst_parser',
'sphinx.ext.apidoc',
'sphinx.ext.intersphinx',
]
templates_path = ['_templates']
exclude_patterns = [
'_build',
'Thumbs.db',
'.DS_Store',
'api/modules.rst', # Generated by apidoc, but we don't need it
]
apidoc_module_first = True
apidoc_exclude_patterns = ['**/cache.py']
apidoc_modules = [
{
'path': '../src/acres',
'destination': 'api',
},
]
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']
|