Skip to content

Commit

Permalink
docs: Disable nitpicking for TypeVars called "T"
Browse files Browse the repository at this point in the history
Sphinx does not seem to resolve these correctly and with nitpick
mode on, Sphinx will produce an error.

See sphinx-doc/sphinx#10974.
  • Loading branch information
jkoelndorfer committed Jan 7, 2024
1 parent d2263d7 commit 07e1725
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,16 @@
"python": ("https://docs.python.org/3", None),
}


# Disables Sphinx nitpicking (i.e. ability to link to docs) for
# specific targets.
#
# See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpick_ignore_regex
nitpick_ignore_regex = [
# Sphinx does not know how to resolve TypeVars.
#
# See https://github.com/sphinx-doc/sphinx/issues/10974.
(r"py:class", r".*\.T"),
]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Expand Down

0 comments on commit 07e1725

Please sign in to comment.