Add a 'make spelling' target to doc/

OSGeo · Aug 15, 2024 · b2eba98 · b2eba98
1 parent d4ab8af
commit b2eba98
Show file tree

Hide file tree

Showing 4 changed files with 3,679 additions and 0 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -94,6 +94,9 @@ man: generated_rst_files
 latexpdf: generated_rst_files
 	$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+spelling: generated_rst_files
+	@$(SPHINXBUILD) -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
 clean:
 	rm -rf "$(BUILDDIR)/xml"
 	rm -rf "$(BUILDDIR)/doxygen_html"

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -71,6 +71,7 @@
     "source_file",
     "sphinx.ext.napoleon",
     "sphinxcontrib.jquery",
+    "sphinxcontrib.spelling",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -533,3 +534,10 @@
 # -- Redirects --------------------------------------------------
 
 enable_redirects = False
+
+# -- Spelling --------------------------------------------------
+
+# Avoid running git
+spelling_ignore_contributor_names = False
+
+spelling_word_list_filename = ["spelling_wordlist.txt"]