Merge pull request #360 from lsst-sqre/tickets/DM-48199

DM-48199: Update comment for Sphinx Path exclusion
lsst-sqre · Dec 18, 2024 · 20e62a9 · 20e62a9
2 parents f1715b5 + babd933
commit 20e62a9
Showing 1 changed file with 1 addition and 3 deletions.
diff --git 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