scverse_doc.config

The extension stack and the shared defaults.

Sets up the extensions in EXTENSIONS, so conf.py lists only scverse_doc, and fills in DEFAULTS. Anything set in conf.py always wins.

scverse_doc.config.EXTENSIONS: Final = ('myst_nb', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', 'sphinx_copybutton', 'sphinx_design', 'sphinxext.opengraph')

Extensions set up alongside this one, so packages list only scverse_doc.

scverse_doc.config.MYST_ENABLE_EXTENSIONS: Final = ('amsmath', 'colon_fence', 'deflist', 'dollarmath', 'html_image', 'html_admonition')

The MyST syntax extensions, i.e. the myst_enable_extensions entry of DEFAULTS.

scverse_doc.config.DEFAULTS: Final = Defaults(autosummary_generate=True, autodoc_member_order='groupwise', napoleon_google_docstring=False, napoleon_numpy_docstring=True, napoleon_include_init_with_doc=False, napoleon_use_param=True, napoleon_use_rtype=True, default_role='literal', myst_enable_extensions=['amsmath', 'colon_fence', 'deflist', 'dollarmath', 'html_image', 'html_admonition'], myst_heading_anchors=6, source_suffix={'.rst': 'restructuredtext', '.md': 'myst-nb', '.ipynb': 'myst-nb'}, nb_execution_mode='off', nb_output_stderr='remove', nb_merge_streams=True, intersphinx_timeout=10, exclude_patterns=['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints'], nitpicky=True)

Sphinx config values applied unless conf.py sets them.

A frozen dataclass() instance: use dataclasses.asdict() to get a dict. Access them by name to create variations of their values, e.g.

from scverse_doc.config import DEFAULTS

exclude_patterns = [*DEFAULTS.exclude_patterns, ...]