pdoc annotations to control auto-docs (#270)

datastax · Mar 28, 2024 · 6717f25 · 6717f25
1 parent d5931f9
commit 6717f25
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/astrapy/__init__.py b/astrapy/__init__.py
@@ -79,3 +79,12 @@ def get_version() -> str:
     "DataAPIClient",
     "__version__",
 ]
+
+
+__pdoc__ = {
+    "api": False,
+    "core": False,
+    "db": False,
+    "ops": False,
+    "ids": False,
+}
diff --git a/astrapy/constants.py b/astrapy/constants.py
@@ -102,3 +102,8 @@ def __init__(self) -> None:
     UUIDV6 = "uuidv6"
     UUIDV7 = "uuidv7"
     DEFAULT = "uuid"
+
+
+__pdoc__ = {
+    "normalize_optional_projection": False,
+}
diff --git a/astrapy/exceptions.py b/astrapy/exceptions.py
@@ -785,3 +785,10 @@ def remaining_timeout_info(self) -> Union[TimeoutInfo, None]:
         for use within the multi-call method.
         """
         return base_timeout_info(max_time_ms=self.remaining_timeout_ms())
+
+
+__pdoc__ = {
+    "base_timeout_info": False,
+    "to_dataapi_timeout_exception": False,
+    "MultiCallTimeoutManager": False,
+}