From c47630f83ddee4a437aeee86d30a04ade067de4d Mon Sep 17 00:00:00 2001 From: James Orson Date: Fri, 12 Feb 2021 20:21:14 -0800 Subject: [PATCH] PATCH: Fix doc generation in CI/CD --- .github/workflows/ci.yml | 4 ++-- generate_docs.bash | 3 --- komodo.nimble | 3 +++ serve_docs.bash | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) delete mode 100755 generate_docs.bash diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2b0cd2b..dc7c386 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,12 +28,12 @@ jobs: run: | nimble develop cd examples/desktop - nimble buildDesktop -Y + nimble buildDesktop # Generate the Docs - name: Generate documentation run: | - nimble doc --project --outdir:htmldocs --index:on ./src/komodo.nim --git.url:https://github.com/ExoKomodo/KomodoNim --git.commit:develop --git.devel:develop + nimble docKomodo cp htmldocs/theindex.html htmldocs/index.html cp htmldocs/index.html htmldocs/404.html cp README.md ./htmldocs/README.md diff --git a/generate_docs.bash b/generate_docs.bash deleted file mode 100755 index 692982b..0000000 --- a/generate_docs.bash +++ /dev/null @@ -1,3 +0,0 @@ -#! /bin/bash - -nimble doc --project --outdir:htmldocs --index:on ./src/komodo.nim --git.url:https://github.com/ExoKomodo/KomodoNim --git.commit:develop --git.devel:develop diff --git a/komodo.nimble b/komodo.nimble index 98032db..2daace4 100644 --- a/komodo.nimble +++ b/komodo.nimble @@ -11,3 +11,6 @@ binDir = "bin" # Dependencies requires "nim >= 1.4.2" + +task docKomodo, "Generate documentation": + exec "nimble --gc:orc --threads:on doc --project --outdir:htmldocs --index:on ./src/komodo.nim --git.url:https://github.com/ExoKomodo/KomodoNim --git.commit:develop --git.devel:develop" \ No newline at end of file diff --git a/serve_docs.bash b/serve_docs.bash index 0e8b755..71da088 100755 --- a/serve_docs.bash +++ b/serve_docs.bash @@ -1,4 +1,4 @@ #! /bin/bash -./generate_docs.bash +nimble docKomodo python3 -m http.server 7029 --directory htmldocs