Skip to content

Commit

Permalink
WIP: docs with TypeVar in private modules
Browse files Browse the repository at this point in the history
Forks off of #700
  • Loading branch information
evalott100 committed Jan 28, 2025
1 parent 9563aee commit 4a5ca3b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"

Expand Down

0 comments on commit 4a5ca3b

Please sign in to comment.