From babd9339424bf5f93ade0c986a16fe9fbe44b916 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Wed, 18 Dec 2024 12:19:39 -0800 Subject: [PATCH] Update comment for Sphinx Path exclusion Point to the correct Sphinx bug to explain why we're excluding `Path` from Sphinx nitpicks. --- docs/documenteer.toml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/documenteer.toml b/docs/documenteer.toml index 3b9c2b4a..88809cac 100644 --- a/docs/documenteer.toml +++ b/docs/documenteer.toml @@ -61,9 +61,7 @@ nitpick_ignore = [ ["py:class", "_orm.registry"], ["py:class", "_schema.MetaData"], ["py:class", "_schema.Table"], - # Pydantic FilePath types create a reference to Path that is unresolved - # unless Path is imported locally, but the import is removed because the - # symbol isn't referenced. + # See https://github.com/sphinx-doc/sphinx/issues/13178 ["py:class", "pathlib._local.Path"], # The AOIKafkaAdminClient is considered experimental and not officially # exported