add non-imported module to docs

This commit is contained in:
Daylin Morgan 2024-09-25 13:21:19 -05:00
parent 8f890c3e24
commit ee241e2d29
Signed by: daylin
GPG key ID: 950D13E9719334AD
3 changed files with 14 additions and 4 deletions

View file

@ -11,10 +11,9 @@ task docs, "Deploy doc html + search index to public/ directory":
let let
deployDir = getCurrentDir() / "public" deployDir = getCurrentDir() / "public"
pkgName = "hwylterm" pkgName = "hwylterm"
srcFile = getCurrentDir() / fmt"src/{pkgName}.nim"
gitUrl = fmt"https://github.com/daylinmorgan/{pkgName}" gitUrl = fmt"https://github.com/daylinmorgan/{pkgName}"
# selfExec fmt"doc --index:on --git.url:{gitUrl} --git.commit:v{version} --outdir:{deployDir} --project {srcFile}" selfExec fmt"doc --docRoot:{getCurrentDir()}/src/ --index:on --outdir:{deployDir} src/hwylterm/cli"
selfExec fmt"doc --index:on --git.url:{gitUrl} --git.commit:main --outdir:{deployDir} --project {srcFile}" selfExec fmt"doc --project --index:on --git.url:{gitUrl} --git.commit:main --outdir:{deployDir} --project src/{pkgName}.nim"
withDir deployDir: withDir deployDir:
mvFile(pkgName & ".html", "index.html") mvFile(pkgName & ".html", "index.html")
for file in walkDirRec(".", {pcFile}): for file in walkDirRec(".", {pcFile}):

View file

@ -1,2 +1,9 @@
##[
# Hwylterm
[see bbansi](./hwylterm/bbansi.html)
[see cli](./hwylterm/cli.html)
]##
import hwylterm/[spin, bbansi] import hwylterm/[spin, bbansi]
export spin, bbansi export spin, bbansi

View file

@ -1,4 +1,8 @@
## adapter to add hwylterm colors to cligen output ##[
# Hwylterm cligen adapter
Adapter to add hwylterm colors to cligen output.
]##
import std/[tables] import std/[tables]
import cligen import cligen
import ./bbansi import ./bbansi