mirror of
https://github.com/p2p-ld/numpydantic.git
synced 2024-11-14 10:44:28 +00:00
71 lines
2.2 KiB
Python
71 lines
2.2 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
|
||
|
|
|
||
|
|
# -- Project information -----------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||
|
|
|
||
|
|
project = 'numpydantic'
|
||
|
|
copyright = '2024, Jonny Saunders'
|
||
|
|
author = 'Jonny Saunders'
|
||
|
|
release = 'v0.0.0'
|
||
|
|
|
||
|
|
# -- General configuration ---------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
'sphinx.ext.napoleon',
|
||
|
|
'sphinx.ext.autodoc',
|
||
|
|
'sphinxcontrib.autodoc_pydantic',
|
||
|
|
'sphinx.ext.intersphinx',
|
||
|
|
"sphinx_design",
|
||
|
|
'myst_parser',
|
||
|
|
'sphinx.ext.todo'
|
||
|
|
]
|
||
|
|
|
||
|
|
templates_path = ['_templates']
|
||
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||
|
|
|
||
|
|
intersphinx_mapping = {
|
||
|
|
'python': ('https://docs.python.org/3', None),
|
||
|
|
'numpy': ('https://numpy.org/doc/stable/', None),
|
||
|
|
'pydantic': ('https://docs.pydantic.dev/latest/', None),
|
||
|
|
'linkml': ('https://linkml.io/linkml/', None),
|
||
|
|
'linkml_runtime': ('https://linkml.io/linkml/', None),
|
||
|
|
'linkml-runtime': ('https://linkml.io/linkml/', 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']
|
||
|
|
|
||
|
|
# autodoc
|
||
|
|
autodoc_pydantic_model_show_json_error_strategy = 'coerce'
|
||
|
|
autodoc_pydantic_model_show_json = False
|
||
|
|
autodoc_mock_imports = []
|
||
|
|
autoclass_content = "both"
|
||
|
|
autodoc_member_order='bysource'
|
||
|
|
add_module_names = False
|
||
|
|
|
||
|
|
# Napoleon settings
|
||
|
|
napoleon_google_docstring = True
|
||
|
|
napoleon_numpy_docstring = True
|
||
|
|
napoleon_include_init_with_doc = False
|
||
|
|
napoleon_include_private_with_doc = False
|
||
|
|
napoleon_include_special_with_doc = True
|
||
|
|
napoleon_use_admonition_for_examples = False
|
||
|
|
napoleon_use_admonition_for_notes = False
|
||
|
|
napoleon_use_admonition_for_references = False
|
||
|
|
napoleon_use_ivar = False
|
||
|
|
napoleon_use_param = True
|
||
|
|
napoleon_use_rtype = True
|
||
|
|
napoleon_preprocess_types = False
|
||
|
|
napoleon_type_aliases = None
|
||
|
|
napoleon_attr_annotations = True
|
||
|
|
|
||
|
|
# todo
|
||
|
|
todo_include_todos = True
|
||
|
|
todo_link_only = True
|