From 4a5ca3b7edc354dde8fc734dc7e3b7d4a2574ac7 Mon Sep 17 00:00:00 2001
From: Eva Lott <eva.lott@diamond.ac.uk>
Date: Tue, 28 Jan 2025 15:37:49 +0000
Subject: [PATCH] WIP: docs with `TypeVar` in private modules

Forks off of https://github.com/bluesky/ophyd-async/pull/700
---
 docs/conf.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index 2f9d97c2b7..2cb94ed4bf 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -39,6 +39,7 @@
     "sphinxcontrib.autodoc_pydantic",
     # Use this for generating API docs
     "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
     # Not sure if this is still used?
     "sphinx.ext.doctest",
     # and making summary tables at the top of API docs
@@ -91,6 +92,16 @@
     ("py:class", "typing_extensions.Literal"),
 ]
 
+# Regex ignore for anything ending in capital T (typevar).
+# Needed until this is solved https://github.com/sphinx-doc/sphinx/issues/10974
+# nitpick_ignore_regex = [("py:class", r".*T$")]
+
+autodoc_default_options = {
+    "undoc": True,
+    "undoc-members": True,
+    "private-members": True,
+}
+
 # Order the members by the order they appear in the source code
 autodoc_member_order = "bysource"