Adding more options to hide or show modules/packages

readthedocs · Jun 26, 2024 · d5f9e04 · d5f9e04
1 parent 45a074e
commit d5f9e04
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/autoapi/_objects.py b/autoapi/_objects.py
@@ -409,7 +409,11 @@ class PythonModule(TopLevelPythonPythonMapper):
     type = "module"
 
     def _should_skip(self) -> bool:
-        return False
+        skip_private_member = (
+            self.is_private_member and "private-members" not in self.options
+        )
+
+        return self.obj.get("hide", False) or skip_private_member
 
 
 class PythonPackage(TopLevelPythonPythonMapper):
@@ -418,7 +422,11 @@ class PythonPackage(TopLevelPythonPythonMapper):
     type = "package"
 
     def _should_skip(self) -> bool:
-        return False
+        skip_private_member = (
+            self.is_private_member and "private-members" not in self.options
+        )
+
+        return self.obj.get("hide", False) or skip_private_member
 
 
 class PythonClass(PythonObject):