Merge pull request #35 from SciNim/addDocs

build docs in CI when pushing to master

Author: HugoGranstrom

.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: Generate numericalnim docs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  gen:
+    name: Generate and deploy docs
+    runs-on: ubuntu-latest  
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: iffy/install-nim@v4
+      - name: Generate
+        run: |
+          nimble install -y
+          nimble docs
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.gitignore

@@ -4,3 +4,4 @@ bin/
 .vscode/
 *.code-workspace
 *.html
+docs/

numericalnim.nimble

@@ -30,3 +30,8 @@ task test, "Run all tests":
   exec "nim c -r tests/test_optimize.nim"
   exec "nim c -r tests/test_utils.nim"
   exec "nim c -r tests/test_vector.nim"
+
+task docs, "Generate documentation":
+  # Based on Nico's script
+  exec "nim doc --project --index:on --git.url:https://github.com/SciNim/numericalnim --git.commit:master --outdir:docs src/numericalnim.nim"
+  exec "echo \"<meta http-equiv=\\\"Refresh\\\" content=\\\"0; url='theindex.html'\\\" />\" >> docs/index.html"