Skip to content

Commit

Permalink
Update comment for Sphinx Path exclusion
Browse files Browse the repository at this point in the history
Point to the correct Sphinx bug to explain why we're excluding
`Path` from Sphinx nitpicks.
  • Loading branch information
rra committed Dec 18, 2024
1 parent a78f479 commit b6643e4
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions docs/documenteer.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,7 @@ nitpick_ignore = [
# the combination of Sphinx extensions we're using confuse themselves and
# there doesn't seem to be any way to fix this.
["py:class", "asyncio.locks.Lock"],
# 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"],
# Cannot be represented by intersphinx.
["py:obj", "safir.pydantic._validators.validate_exactly_one_of.<locals>.validator"],
Expand Down

0 comments on commit b6643e4

Please sign in to comment.