Skip to content

Commit 987b828

Browse files
authored
Merge pull request #2406 from sirosen/fix-nitpick-rules
Fix malformed nitpick ignore rules; add ignores to let doc builds pass
2 parents 6800e98 + b5d337c commit 987b828

3 files changed

Lines changed: 22 additions & 13 deletions

File tree

changelog.d/+fcb3437a.contrib.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed incorrect nitpick ignore regexes -- by {user}`sirosen`.

docs/conf.py

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,16 +95,24 @@
9595
]
9696

9797
nitpick_ignore_regex = [
98-
("py:class", "pip.*"),
99-
("py:class", "pathlib.*"),
100-
("py:class", "click.*"),
101-
("py:class", "build.*"),
102-
("py:class", "optparse.*"),
103-
("py:class", "_ImportLibDist"),
104-
("py:class", "PackageMetadata"),
105-
("py:class", "importlib.*"),
98+
# FIXME: broken refs inside of pip-tools itself
99+
# internal names with leading '_', mostly type vars
100+
("py:.*", r"piptools\..*\._\w+"),
101+
# BaseRepository ref is broken?
102+
("py:class", r"piptools\.repositories\.BaseRepository"),
103+
# external libraries
104+
("py:.*", r"click\..*"),
105+
("py:.*", r"pip\..*"),
106+
("py:class", "NormalizedName"),
107+
("py:exc", "InvalidName"),
106108
("py:class", "IndexContent"),
107-
("py:exc", "click.*"),
109+
("py:class", "PackageMetadata"),
110+
("py:class", "_ImportLibDist"),
111+
("py:class", r"build\..*"),
112+
# stdlib
113+
("py:class", r"importlib\..*"),
114+
("py:class", r"optparse\..*"),
115+
("py:class", r"pathlib\..*"),
108116
]
109117

110118
suppress_warnings = [

docs/requirements.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ boltons==25.0.0
1616
# via click-extra
1717
bracex==2.6
1818
# via wcmatch
19-
build==1.4.0
19+
build==1.5.0
2020
# via pip-tools (pyproject.toml)
2121
certifi==2026.1.4
2222
# via requests
@@ -140,17 +140,17 @@ towncrier==25.8.0
140140
# via sphinxcontrib-towncrier
141141
typing-extensions==4.15.0
142142
# via beautifulsoup4
143-
urllib3==2.6.3
143+
urllib3==2.7.0
144144
# via requests
145145
wcmatch==10.1
146146
# via click-extra
147147
wcwidth==0.5.3
148148
# via tabulate
149-
wheel==0.46.3
149+
wheel==0.47.0
150150
# via pip-tools (pyproject.toml)
151151

152152
# The following packages are considered to be unsafe in a requirements file:
153-
pip==26.0
153+
pip==26.1.1
154154
# via pip-tools (pyproject.toml)
155155
setuptools==80.10.2
156156
# via

0 commit comments

Comments
 (0)