feat: add automatically generated documentation for key modules

Author: dhellmann

docs/source/code.rst

@@ -0,0 +1,39 @@
+====
+Code
+====
+
+spelling.builder
+================
+
+.. automodule:: sphinxcontrib.spelling.builder
+   :members:
+
+spelling.checker
+================
+
+.. automodule:: sphinxcontrib.spelling.checker
+   :members:
+
+spelling.directive
+==================
+
+.. automodule:: sphinxcontrib.spelling.directive
+   :members:
+
+spelling.domain
+================
+
+.. automodule:: sphinxcontrib.spelling.domain
+   :members:
+
+spelling.filters
+================
+
+.. automodule:: sphinxcontrib.spelling.filters
+   :members:
+
+spelling.role
+================
+
+.. automodule:: sphinxcontrib.spelling.role
+   :members:

docs/source/conf.py

@@ -9,12 +9,14 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 import os
+import pathlib
 import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(pathlib.Path("..", "src").resolve()))
 
 # -- General configuration -----------------------------------------------------
 
@@ -25,6 +27,7 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     "sphinxcontrib.spelling",
+    "sphinx.ext.autodoc",
 ]
 
 spelling_word_list_filename = [

docs/source/history.rst

@@ -26,6 +26,7 @@ Next
 
 - Modernize packaging using hatch and hatchling.
 - List Python 3.13 as supported.
+- Add automatically generated documentation for key modules.
 
 Bug Fixes
 ---------

docs/source/index.rst

@@ -34,6 +34,7 @@ Details
    customize
    run
    developers
+   code
    history
 
 

docs/source/spelling_wordlist.txt

@@ -12,3 +12,4 @@ wikis
 wordfiles
 wordlist
 wordlists
+domaindata

pyproject.toml

@@ -61,7 +61,6 @@ ENABLE_SPELLING = "1"
 [tool.hatch.envs.docs.scripts]
 build = [
     "sphinx-build -W -j auto -b html -d docs/build/doctrees docs/source docs/build/html",
-    "sphinx-build -W -j auto -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck",
     "sphinx-build -W -j auto -b spelling -d docs/build/doctrees docs/source docs/build/spelling",
 ]
 check = "sphinx-build -W -j auto -b spelling -d docs/build/doctrees docs/source docs/build/spelling"

sphinxcontrib/spelling/builder.py

@@ -183,6 +183,7 @@ def format_suggestions(self, suggestions):
     }
 
     def write_doc(self, docname, doctree):
+        """write the document"""
         lines = list(self._find_misspellings(docname, doctree))
         self.misspelling_count += len(lines)
         if lines:

sphinxcontrib/spelling/domain.py

@@ -15,6 +15,7 @@ def get_objects(self):
         return []
 
     def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
+        """resolve cross reference"""
         return None
 
     def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):