From 6b29bcec5c8cd5d68b6d52a34bb3875b3aaf582b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Gr=C3=B6nholm?= Date: Mon, 1 Aug 2022 02:22:15 +0300 Subject: Added sphinx_autodoc_typehints and adjusted Sphinx autodoc options --- docs/conf.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 561a5b8..5fcb774 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,12 @@ author = "Alex Grönholm" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx_tabs.tabs"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx_tabs.tabs", + "sphinx_autodoc_typehints", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -38,6 +43,8 @@ templates_path = ["_templates"] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] +autodoc_default_options = {"members": True, "show-inheritance": True} +autodoc_mock_imports = ["asyncpg", "cbor2", "paho", "pymongo", "redis", "sqlalchemy"] # -- Options for HTML output ------------------------------------------------- -- cgit v1.2.1