implement and use a proper nanopass framework

.github/workflows/build_and_test.yml

@@ -168,3 +168,25 @@ jobs:
         env:
           TEST_FILE: tests/expr/t06_call_proc_with_tuple_return_type.test
           TEST_OUTPUT: "(TupleCons 100 200) : (TupleTy (IntTy) (IntTy))(Done 0)"
+
+  docs:
+    name: "Test documentation"
+    runs-on: "ubuntu-latest"
+
+    needs: context
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          filter: tree:0
+
+      - uses: nim-works/setup-nimskull@0.1.2
+        with:
+          nimskull-version: "${{ needs.context.outputs.nimskull-version }}"
+
+      - name: Build koch
+        run: nim c --outdir:bin koch.nim
+
+      - name: Build and test documentation
+        run: bin/koch docs

koch.nim

@@ -17,6 +17,7 @@ Commands:
   generate <dir>              generates the various language-related modules
   build-defs                  verifies the language definitions and generates
                               the textual representation for them
+  docs                        builds all documentation
 """
   Programs = {
     "tester" : ("tools/tester.nim", true),
@@ -32,6 +33,10 @@ Commands:
   DefaultGenerated = "generated"
     ## the default path for the generated modules
 
+  RstList = @[
+    "nanopass/manual.rst"
+  ]
+
 var
   nimExe = findExe("nim")
   verbose = true
@@ -58,6 +63,14 @@ proc compile(file: sink string, name: string, extra: varargs[string]): bool =
   args.add file
   result = run(nimExe, args)
 
+proc rstToHtml(file: sink string, dir: string, extra: varargs[string]): bool =
+  ## Runs RST-to-HTML conversion on `file`, using `dir` as the
+  ## output directory.
+  var args = @["rst2html", "--nimcache:build/docs/", "--outdir:" & dir]
+  args.add extra
+  args.add file
+  result = run(nimExe, args)
+
 proc check(file: sink string, extra: varargs[string]): bool =
   ## Runs the ``check`` command on the given NimSkull `file`.
   var args = @["check"]
@@ -184,6 +197,23 @@ proc buildDefs(args: string): bool =
 
   result = true
 
+proc buildDocs(args: string): bool =
+  ## Handles building and testing the various documentation.
+  if args.len > 0:
+    return false
+
+  let docroot = getCurrentDir() / "build" / "docs"
+  createDir(docroot)
+
+  for it in RstList.items:
+    # the output is not relevant at the moment, so it's simply dumped into the
+    # artifacts directory
+    if not rstToHtml(it, docroot):
+      echo "Failure"
+      quit(1)
+
+  result = true
+
 proc showHelp(): bool =
   ## Shows the help text.
   echo HelpText
@@ -213,6 +243,8 @@ while true:
         generate(opts.cmdLineRest)
       of "build-defs":
         buildDefs(opts.cmdLineRest)
+      of "docs":
+        buildDocs(opts.cmdLineRest)
       of "help":
         showHelp()
       else:

nanopass/README.md

@@ -0,0 +1,2 @@
+This directory contains the implementation of the nanopass framework used by
+various parts of Phy.