Doc: (investigate if we can) turn on nitpicky = True

Open rouault opened this issue 7 months ago • 2 comments

Feature description

Sphinx has a nitpicky = True mode (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky) to set in conf.py to check that all targets of references are found. In particular for the C/C++/Python API. Currently when trying to enable it, hundreds of warnings are thrown. A number of them are legitimate to fix (cf https://github.com/OSGeo/gdal/pull/12336 for related fixes) . The remainder could be shut off with nitpick_ignore/nitpick_ignore_regex

Additional context

No response

May 10 '25 17:05 rouault

@rouault - I've just run locally and can see the various issues (and non-issues). You can assign this to me, and I'll start resolving some of these as I go through the Python bindings documentation.

May 11 '25 11:05 geographika

nipicky=true enabled in https://github.com/OSGeo/gdal/pull/12715 but with mass suppression for all Python related warnings

Jul 06 '25 17:07 rouault