Don't generate documentation for internal modules

Internal modules (and packages) start with `_`, and should be ignored
when generating the documentation.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

docs/mkdocstrings_autoapi.py

@@ -8,12 +8,30 @@
 """
 
 from pathlib import Path
+from typing import Tuple
 
 import mkdocs_gen_files
 
 SRC_PATH = "src"
 DST_PATH = "reference"
 
+
+def is_internal(path_parts: Tuple[str, ...]) -> bool:
+    """Tell if the path is internal judging by the parts.
+
+    Args:
+        path_parts: Path.parts of the path to check.
+
+    Returns:
+        True if the path is internal.
+    """
+
+    def with_underscore_not_init(part: str) -> bool:
+        return part.startswith("_") and part != "__init__"
+
+    return any(p for p in path_parts if with_underscore_not_init(p))
+
+
 # type ignore because mkdocs_gen_files uses a very weird module-level
 # __getattr__() which messes up the type system
 nav = mkdocs_gen_files.Nav()
@@ -24,6 +42,8 @@
     doc_path = path.relative_to(SRC_PATH).with_suffix(".md")
     full_doc_path = Path(DST_PATH, doc_path)
     parts = tuple(module_path.parts)
+    if is_internal(parts):
+        continue
     if parts[-1] == "__init__":
         doc_path = doc_path.with_name("index.md")
         full_doc_path = full_doc_path.with_name("index.md")