From 70f597fcfb6fee33230022f55dd7e5a13afccc01 Mon Sep 17 00:00:00 2001 From: Mike A Date: Wed, 3 Jan 2024 22:20:35 +0100 Subject: [PATCH] Hide private elements in docs --- docs/conf.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8c17da0..81edb15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,11 +15,21 @@ release = "0.2.1" # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = ["sphinx.ext.duration", "autoapi.extension"] -autoapi_dirs = ["../findmy/"] templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +# -- AutoAPI Options --------------------------------------------------------- +autoapi_dirs = ["../findmy/"] +autoapi_options = [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", + "imported-members", +] + # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output