From a6120b3723b742c58245466f3eabe4e6ef9a0269 Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Thu, 26 Sep 2024 08:53:01 -0500 Subject: [PATCH] refactor doc generation --- config.nims | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/config.nims b/config.nims index 5cbb571..30c69fc 100644 --- a/config.nims +++ b/config.nims @@ -7,14 +7,8 @@ task develop, "install cligen for development": exec "nimble install -l 'illwill@0.4.1'" exec "nimble install -l 'cligen@1.7.5'" -task docs, "Deploy doc html + search index to public/ directory": - let - deployDir = getCurrentDir() / "public" - pkgName = "hwylterm" - gitUrl = fmt"https://github.com/daylinmorgan/{pkgName}" - for module in ["cli", "chooser"]: - selfExec fmt"doc --docRoot:{getCurrentDir()}/src/ --index:on --outdir:{deployDir} src/hwylterm/{module}" - selfExec fmt"doc --project --index:on --git.url:{gitUrl} --git.commit:main --outdir:{deployDir} --project src/{pkgName}.nim" +proc docFixup(deployDir:string, pkgName: string) = + ## apply renames to api docs withDir deployDir: mvFile(pkgName & ".html", "index.html") for file in walkDirRec(".", {pcFile}): @@ -23,6 +17,16 @@ task docs, "Deploy doc html + search index to public/ directory": # drop 'src/' from titles exec(r"sed -i -r 's/<(.*)>src\//<\1>/' $1" % file) +task docs, "Deploy doc html + search index to public/ directory": + let + deployDir = getCurrentDir() / "public" + pkgName = "hwylterm" + gitFlags = fmt"--git.url:'https://github.com/daylinmorgan/{pkgName}' --git.commit:main" + for module in ["cli", "chooser"]: + selfExec fmt"doc --docRoot:{getCurrentDir()}/src/ --index:on --outdir:{deployDir} src/hwylterm/{module}" + selfExec fmt"doc --project --index:on {gitFlags} --outdir:{deployDir} --project src/{pkgName}.nim" + docFixup(deployDir,pkgName) + when withDir(thisDir(), system.dirExists("nimbledeps")): --path:"./nimbledeps/pkgs2/cligen-1.7.5-f3ffe7329c8db755677d3ca377d02ff176cec8b1" --path:"./nimbledeps/pkgs2/illwill-0.4.1-9c58351502f89a16caf031cbd1992ad3fdfd3c67"