Skip to content

Commit c8cc2f6

Browse files
committed
Fix Sphinx documentation build warnings
Add missing C++ enumerators to the nitpick_ignore list in conf.cmake.in.py to resolve 162 broken cross-reference warnings. The warnings were caused by references to API enumerators (hook IDs, return values, milestones, etc.) that are defined in C++ headers but not formally documented in Sphinx. Also cleaned up duplicate entries and organized the list with category comments for maintainability. With this change, the docs now build without warnings.
1 parent a399830 commit c8cc2f6

File tree

1 file changed

+71
-12
lines changed

1 file changed

+71
-12
lines changed

doc/conf.cmake.in.py

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ def configure_graphviz_format(app):
207207

208208
nitpicky = True
209209
nitpick_ignore = [
210+
# Standard C/C++ types
210211
('cpp:identifier', 'int64_t'),
211212
('cpp:identifier', 'uint64_t'),
212213
('cpp:identifier', 'uint8_t'),
@@ -215,26 +216,84 @@ def configure_graphviz_format(app):
215216
('cpp:identifier', 'ssize_t'),
216217
('cpp:identifier', 'sockaddr'),
217218
('cpp:identifier', 'time_t'),
218-
('cpp:identifier', 'time_t'),
219+
# External library types
219220
('cpp:identifier', 'swoc'),
220221
('cpp:identifier', 'swoc::Rv<Directive::Handle>'),
221222
('cpp:identifier', 'Directive::Handle'),
222223
('cpp:identifier', 'CfgStaticData'),
223224
('cpp:identifier', 'YAML'),
224225
('cpp:identifier', 'YAML::Node'),
225-
('cpp:identifier', 'swoc'),
226-
('cpp:identifier', 'swoc::TextView'),
227-
('cpp:identifier', 'swoc'),
228226
('cpp:identifier', 'swoc::TextView'),
229-
('cpp:identifier', 'YAML'),
230-
('cpp:identifier', 'YAML::Node'),
231-
('cpp:identifier', 'swoc'),
232227
('cpp:identifier', 'swoc::Errata'),
233-
('cpp:identifier', 'CfgStaticData'),
234-
('cpp:identifier', 'T'), # template arg
235-
('cpp:identifier', 'F'), # template arg
236-
('cpp:identifier', 'Args'), # variadic template arg
237-
('cpp:identifier', 'Rest'), # variadic template arg
228+
# Template arguments
229+
('cpp:identifier', 'T'),
230+
('cpp:identifier', 'F'),
231+
('cpp:identifier', 'Args'),
232+
('cpp:identifier', 'Rest'),
233+
# Event system
234+
('cpp:identifier', 'EVENT_IMMEDIATE'),
235+
# API return values
236+
('cpp:enumerator', 'TS_SUCCESS'),
237+
('cpp:enumerator', 'TS_ERROR'),
238+
# HTTP hook IDs
239+
('cpp:enumerator', 'TS_HTTP_READ_REQUEST_HDR_HOOK'),
240+
('cpp:enumerator', 'TS_HTTP_READ_RESPONSE_HDR_HOOK'),
241+
('cpp:enumerator', 'TS_HTTP_SEND_REQUEST_HDR_HOOK'),
242+
('cpp:enumerator', 'TS_HTTP_SEND_RESPONSE_HDR_HOOK'),
243+
('cpp:enumerator', 'TS_HTTP_OS_DNS_HOOK'),
244+
('cpp:enumerator', 'TS_HTTP_PRE_REMAP_HOOK'),
245+
('cpp:enumerator', 'TS_HTTP_POST_REMAP_HOOK'),
246+
('cpp:enumerator', 'TS_HTTP_TXN_START_HOOK'),
247+
('cpp:enumerator', 'TS_HTTP_TXN_CLOSE_HOOK'),
248+
('cpp:enumerator', 'TS_HTTP_SSN_START_HOOK'),
249+
('cpp:enumerator', 'TS_HTTP_SSN_CLOSE_HOOK'),
250+
('cpp:enumerator', 'TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK'),
251+
('cpp:enumerator', 'TS_HTTP_READ_CACHE_HDR_HOOK'),
252+
('cpp:enumerator', 'TS_HTTP_SELECT_ALT_HOOK'),
253+
('cpp:enumerator', 'TS_HTTP_REQUEST_TRANSFORM_HOOK'),
254+
('cpp:enumerator', 'TS_HTTP_RESPONSE_TRANSFORM_HOOK'),
255+
('cpp:enumerator', 'TS_HTTP_REQUEST_BUFFER_READ_COMPLETE_HOOK'),
256+
# SSL/TLS hook IDs
257+
('cpp:enumerator', 'TS_SSL_CLIENT_HELLO_HOOK'),
258+
('cpp:enumerator', 'TS_SSL_SERVERNAME_HOOK'),
259+
('cpp:enumerator', 'TS_SSL_SNI_HOOK'),
260+
('cpp:enumerator', 'TS_SSL_CERT_HOOK'),
261+
('cpp:enumerator', 'TS_VCONN_START_HOOK'),
262+
# Lifecycle hooks
263+
('cpp:enumerator', 'TS_LIFECYCLE_SSL_SECRET_HOOK'),
264+
# Transaction milestones
265+
('cpp:enumerator', 'TS_MILESTONE_SM_START'),
266+
('cpp:enumerator', 'TS_MILESTONE_UA_CLOSE'),
267+
('cpp:enumerator', 'TS_MILESTONE_SERVER_CLOSE'),
268+
('cpp:enumerator', 'TS_MILESTONE_PLUGIN_ACTIVE'),
269+
('cpp:enumerator', 'TS_MILESTONE_PLUGIN_TOTAL'),
270+
# HTTP types and status
271+
('cpp:enumerator', 'TS_HTTP_TYPE_UNKNOWN'),
272+
('cpp:enumerator', 'TS_HTTP_STATUS_NONE'),
273+
('cpp:enumerator', 'TS_HTTP_STATUS_BAD_REQUEST'),
274+
# Parse results
275+
('cpp:enumerator', 'TS_PARSE_ERROR'),
276+
('cpp:enumerator', 'TS_PARSE_DONE'),
277+
('cpp:enumerator', 'TS_PARSE_CONT'),
278+
# VConnection
279+
('cpp:enumerator', 'TS_VC_CLOSE_ABORT'),
280+
# Record types and data types
281+
('cpp:enumerator', 'TS_RECORDTYPE_NULL'),
282+
('cpp:enumerator', 'TS_RECORDTYPE_CONFIG'),
283+
('cpp:enumerator', 'TS_RECORDDATATYPE_INT'),
284+
('cpp:enumerator', 'TS_RECORDDATATYPE_FLOAT'),
285+
('cpp:enumerator', 'TS_RECORDDATATYPE_STRING'),
286+
('cpp:enumerator', 'TS_RECORDDATATYPE_COUNTER'),
287+
('cpp:enumerator', 'TS_RECORDCHECK_STR'),
288+
# Remap plugin return values
289+
('cpp:enumerator', 'TSREMAP_DID_REMAP'),
290+
('cpp:enumerator', 'TSREMAP_DID_REMAP_STOP'),
291+
('cpp:enumerator', 'TSREMAP_NO_REMAP'),
292+
('cpp:enumerator', 'TSREMAP_NO_REMAP_STOP'),
293+
('cpp:enumerator', 'TSREMAP_ERROR'),
294+
('cpp:enumerator', 'TSREMAP_CONFIG_RELOAD_FAILURE'),
295+
('cpp:enumerator', 'TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_USED'),
296+
('cpp:enumerator', 'TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_UNUSED'),
238297
]
239298

240299
# Autolink issue references.

0 commit comments

Comments
 (0)