knuth-bendix-class: doc complete

james-d-mitchell · Feb 3, 2025 · 3398170 · 3398170
1 parent 0da7724
commit 3398170
Show file tree

Hide file tree

Showing 4 changed files with 596 additions and 665 deletions.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -260,7 +260,7 @@ PYTHON_DOCSTRING       = YES
 # documentation from any documented member that it re-implements.
 # The default value is: YES.
 
-INHERIT_DOCS           = NO
+INHERIT_DOCS           = YES
 
 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
 # page for each member. If set to NO, the documentation of a member will be part
@@ -622,7 +622,7 @@ HIDE_UNDOC_MEMBERS     = NO
 # if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all
 # undocumented namespaces that are normally visible in the namespace hierarchy.

diff --git a/docs/fixup.py b/docs/fixup.py
@@ -343,6 +343,11 @@ def fix_pages_1(data: str) -> tuple[str, bool]:
 
 
 def delete_matching(filename: str, pattern: str) -> bool:
+    """
+    Not used, but a function that will delete every <tr> in the html files
+    <filename> that match <pattern>. A bit of a blunt instrument.
+    """
+
     def do_it(data: str):
         nonlocal pattern, filename
         pattern = re.compile(pattern)