From 49011e5216d18059c4b1cda83eb8e465222f824f Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Fri, 16 Aug 2024 12:28:40 +0200 Subject: [PATCH] Doc: document the 'spelling' target --- doc/source/development/dev_documentation.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/development/dev_documentation.rst b/doc/source/development/dev_documentation.rst index b48b3b492c41..0dd69130f4c0 100644 --- a/doc/source/development/dev_documentation.rst +++ b/doc/source/development/dev_documentation.rst @@ -41,6 +41,11 @@ The following targets are available: verifies that there are no Doxygen warnings. Requires Doxygen >= 1.9.3 to be warning free. +* ``spelling``: runs spell checking on the documentation, covering as well as + documentation generated from C/C++ API (Doxygen) and Python API. Words unknown + to the spell checker but still considered valid should be added to the allow + list in :file:`doc/source/spelling_wordlist.txt` + * ``clean``: clean the ``doc/build`` directory. It is also possible to run those targets as CMake targets. In that case, the