Avoid writing docs for extension module

Author: znicholls

Makefile

@@ -68,15 +68,15 @@ test:  ## run the tests (re-installs the package every time so you might want to
 
 .PHONY: docs
 docs:  ## build the docs
-	uv run mkdocs build
+	uv run --no-sync mkdocs build
 
 .PHONY: docs-strict
 docs-strict:  ## build the docs strictly (e.g. raise an error on warnings, this most closely mirrors what we do in the CI)
-	uv run mkdocs build --strict
+	uv run --no-sync mkdocs build --strict
 
 .PHONY: docs-serve
 docs-serve:  ## serve the docs locally
-	uv run mkdocs serve
+	uv run --no-sync mkdocs serve
 
 .PHONY: changelog-draft
 changelog-draft:  ## compile a draft of the next changelog

docs/gen_doc_stubs.py

@@ -48,6 +48,9 @@ def write_subpackage_pages(subpackage: object) -> tuple[PackageInfo, ...]:
     for _, name, is_pkg in pkgutil.walk_packages(subpackage.__path__):
         subpackage_full_name = subpackage.__name__ + "." + name
         sub_package_info = write_package_page(subpackage_full_name)
+        if sub_package_info is None:
+            continue
+
         sub_sub_packages.append(sub_package_info)
 
     return tuple(sub_sub_packages)
@@ -66,7 +69,7 @@ def get_write_file(package_full_name: str) -> Path:
 
 def write_package_page(
     package_full_name: str,
-) -> PackageInfo:
+) -> PackageInfo | None:
     """
     Write the docs pages for a package (or sub-package)
     """
@@ -76,6 +79,8 @@ def write_package_page(
         write_subpackage_pages(package)
 
     package_name = package_full_name.split(".")[-1]
+    if package_name == "_lib":
+        return None
 
     write_file = get_write_file(package_full_name)