Linkcheck Failure Reports
Author: steve-chavezCreated May 28, 2025Updated Sep 16, 2026
Labelscidocs
Problem
On https://github.com/PostgREST/postgrest/pull/4099#discussion_r2111130776, an invalid reference was not caught by linkcheck.
With `RPC <functions>`_, the preference is honored completely on the basis of the number of rows returned in the result set of the function. This can be useful for complex mutation queries using `data-modifying statements <https://www.postgresql.org/docs/current/queries-with.html#QUERIES-WITH-MODIFYING>`_.Tthe "functions" reference is invalid here and when clicked on rendered docs it redirected to a "404 not found".
Solution
Looks like we can use nitpicky for this:
In nitpicky mode, Sphinx will warn about all references where the target cannot be found. https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-nitpicky-mode
Notes
If the above doesn't work maybe https://github.com/rstcheck/rstcheck can help?
Source: PostgREST/postgrest