From 4d054d28c1c8b595a066b9ab03a18442d0a6d602 Mon Sep 17 00:00:00 2001 From: juanmc2005 Date: Mon, 13 Nov 2023 20:37:31 +0100 Subject: [PATCH] Ignore private attrs in docs --- docs/conf.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index a8807bf9..2432e5a5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,6 +24,15 @@ ] autoapi_dirs = ["../src/diart"] +autoapi_ignore = ["*__init__"] +autoapi_options = [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", + "imported-members", +] templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] @@ -48,12 +57,7 @@ def skip_submodules(app, what, name, obj, skip, options): - return ( - name.startswith("_") - or name.endswith("__init__") - or name.startswith("diart.console") - or name.startswith("diart.argdoc") - ) + return name.startswith("diart.console") or name.startswith("diart.argdoc") def setup(sphinx):