scverse_doc.config#
The extension stack and the shared defaults.
EXTENSIONS are set up on top of this one, DEFAULTS are applied to the config.
Both are defaults: a value set in conf.py always wins.
- scverse_doc.config.EXTENSIONS = ('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 = ('amsmath', 'colon_fence', 'deflist', 'dollarmath', 'html_image', 'html_admonition')#
The MyST syntax extensions, i.e. the
myst_enable_extensionsentry ofDEFAULTS.
- scverse_doc.config.DEFAULTS: dict[str, Any] = {'autodoc_member_order': 'groupwise', 'autosummary_generate': True, 'default_role': 'literal', 'exclude_patterns': ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints'], 'intersphinx_timeout': 10, 'myst_enable_extensions': ['amsmath', 'colon_fence', 'deflist', 'dollarmath', 'html_image', 'html_admonition'], 'myst_heading_anchors': 6, 'napoleon_google_docstring': False, 'napoleon_include_init_with_doc': False, 'napoleon_numpy_docstring': True, 'napoleon_use_param': True, 'napoleon_use_rtype': True, 'nb_execution_mode': 'off', 'nb_merge_streams': True, 'nb_output_stderr': 'remove', 'nitpicky': True, 'source_suffix': {'.ipynb': 'myst-nb', '.md': 'myst-nb', '.rst': 'restructuredtext'}}#
Sphinx config values applied unless
conf.pysets them.