buildindex and keep testresults in rootdir

Author: noahehall

.github/scripts/docs.nims

@@ -1,8 +1,5 @@
 #!/usr/bin/env nim
 
-# TODO(noah): build the index AFTER doc generation
-# ^ @see https://nim-lang.github.io/Nim/docgen.html#related-options-buildindex-command
-
 import std / [os, strformat]
 
 import
@@ -54,6 +51,14 @@ proc createSourceDocs: (string, int) =
   except OSError:
     ("failed to create documentation", 1)
 
+proc createSourceDocsIndex: (string, int) =
+  echo "create user-serachable index HTML"
+  try:
+    fmt"buildIndex -o:{rootDir/docsDir}/theindex.html {rootDir / docsDir}".selfExec
+    ("user-searchable index HTML created", 0)
+  except OSError:
+    ("failed to user-searchable index", 1)
+
 proc createTestResults: (string, int) = createTestResultsHtml()
 
 proc createDependencyGraphs: (string, int) =
@@ -70,7 +75,7 @@ proc mvFilesToHtmlDocsDir: (string, int) =
     for output in @[
       rootDir / "src/bookofnim.dot",
       rootDir / "src/bookofnim.png",
-      rootDir / "testresults.html" # TODO think this broke viewing testresults in github pages
+      # rootDir / "testresults.html" # TODO(noah) think this broke viewing testresults in github pages
     ]: output.mvFile rootDir / docsDir / output.extractFilename
     ("documentation moved to htmldocs dir", 0)
   except CatchableError:
@@ -81,6 +86,7 @@ when isMainModule:
     installDeps,
     deletePrevdocs,
     createSourceDocs,
+    createSourceDocsIndex,
     createDependencyGraphs,
     createTestResults,
     mvFilesToHtmlDocsDir # must occur last

src/bookofnim.nim

@@ -18,7 +18,7 @@
 
 links
 -----
-- [latest test results](https://noahehall.github.io/nim/htmldocs/testresults.html)
+- [latest test results](https://noahehall.github.io/nim/testresults.html)
 - use nims devel branch until the online documentation for v2 is ready
   - [docs](https://github.com/nim-lang/Nim/tree/devel/doc)
   - [system](https://github.com/nim-lang/Nim/blob/devel/lib/system.nim)

src/bookofnim/deepdives/osIo.nim

@@ -67,6 +67,7 @@ links
 - other
   - [nitch source code](https://github.com/unxsh/nitch)
   - [peter: handling files in nim](https://peterme.net/handling-files-in-nim.html)
+  - [consuming data from thousands of small files](https://forum.nim-lang.org/t/10146)
 - high impact
   - [basic os utils](https://nim-lang.github.io/Nim/os.html)
   - [distro detection & os pkg manager](https://nim-lang.github.io/Nim/distros.html)

src/bookofnim/helloworld/modules/exceptionHandlingDocs.nim

@@ -27,7 +27,6 @@
   - tracebacks:
     - each line in the stack track is a call to a procedure
 
-
 - drnim
   - requires koch to be setup