| # 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 = "Template Python project" | |
| copyright = "2023, Polyconseil" | |
| author = "Anthony Truchet" | |
| release = "0.1" | |
| # -- General configuration --------------------------------------------------- | |
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | |
| templates_path = ["_templates"] | |
| exclude_patterns = [] | |
| extensions = [ | |
| "sphinx.ext.autodoc", | |
| "sphinx.ext.autosummary", | |
| "sphinx.ext.napoleon", | |
| "sphinx.ext.todo", | |
| "myst_parser", | |
| "sphinx_rtd_theme", | |
| ] | |
| autodoc_typehints = "signature" | |
| autodoc_default_options = { | |
| "members": True, | |
| "member-order": "bysource", | |
| "special-members": "__call__", | |
| "undoc-members": True, | |
| "exclude-members": "__weakref__", | |
| "show-inheritance": True, | |
| "autodoc_typehints": "signature", | |
| } | |
| autosummary_generate = True | |
| # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html | |
| todo_include_todos = True | |
| # -- Options for HTML output ------------------------------------------------- | |
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | |
| # html_theme = 'alabaster' | |
| html_theme = "sphinx_rtd_theme" | |
| html_static_path = ["_static"] | |