Docs: Also look for keyword mentions in other subdirs

hfp · Dec 20, 2024 · 308a163 · 308a163
1 parent 77f400e
commit 308a163
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/generate_input_reference.py b/docs/generate_input_reference.py
@@ -386,9 +386,10 @@ def render_keyword(
 def find_all_mentions() -> Dict[str, Set[Path]]:
     root_dir = Path(__file__).resolve().parent
     mentions = defaultdict(set)
-    for fn in (root_dir / "methods").glob("**/*.md"):
-        for xref in re.findall(r"\(#(CP2K_INPUT\..*)\)", fn.read_text()):
-            mentions[xref].add(fn.relative_to(root_dir))
+    for subdir in "getting-started", "methods", "technologies":
+        for fn in (root_dir / subdir).glob("**/*.md"):
+            for xref in re.findall(r"\(#(CP2K_INPUT\..*)\)", fn.read_text()):
+                mentions[xref].add(fn.relative_to(root_dir))
     return mentions
 
 

diff --git a/docs/technologies/eigensolvers/dlaf.md b/docs/technologies/eigensolvers/dlaf.md
@@ -25,7 +25,7 @@ and optional dependencies.
 ## CP2K Input File
 
 [DLA-Future] can be selected in the CP2K input file with the
-[`PREFERRED_DIAG_LIBRARY`](#CP2K_INPUT.GLOBAL.PREFERRED_DIAG_LIBRARY) keyword:
+[PREFERRED_DIAG_LIBRARY](#CP2K_INPUT.GLOBAL.PREFERRED_DIAG_LIBRARY) keyword:
 
 ```
 &GLOBAL
@@ -35,7 +35,7 @@ and optional dependencies.
 &END GLOBAL
 ```
 
-The [`DLAF_NEIGVEC_MIN`](#CP2K_INPUT.GLOBAL.DLAF_NEIGVEC_MIN) indicates the minimum matrix size for
+The [DLAF_NEIGVEC_MIN](#CP2K_INPUT.GLOBAL.DLAF_NEIGVEC_MIN) indicates the minimum matrix size for
 which DLA-Future is used instead of ScaLAPACK. DLA-Future is optimized for large matrices on GPUs,
 and might be slower than ScaLAPACK for small matrices or CPU matrices.