Doc: document the 'spelling' target

OSGeo · Aug 16, 2024 · 49011e5 · 49011e5
1 parent 4e7b806
commit 49011e5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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