From bf81af2da2251cc68364ea2c40d1e8e117d4a016 Mon Sep 17 00:00:00 2001 From: Ganesh Viswanathan Date: Tue, 24 Mar 2020 15:54:26 -0500 Subject: Update documentation --- docs.html | 152 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 docs.html (limited to 'docs.html') diff --git a/docs.html b/docs.html new file mode 100644 index 0000000..d7955c5 --- /dev/null +++ b/docs.html @@ -0,0 +1,152 @@ + + + + + + + + + + + + + + + + + + +docs + + + + + + + + +
+
+

docs

+
+
+
+ +     Dark Mode +
+ +
+ Search: +
+
+ Group by: + +
+ + +
+
+
+ +

+
+

Procs

+
+ +
proc buildDocs(files: openArray[string]; path: string;
+              baseDir = getProjectPath() & "/"; defines: openArray[string] = @[]) {...}{.
+    raises: [OSError, ValueError], tags: [ReadIOEffect].}
+
+ +

Generate docs for all specified nim files to the specified path

+

baseDir is the project path by default and files and path are relative to that directory. Set to "" if using absolute paths.

+

defines is a list of -d:xxx define flags (the xxx part) that should be passed to nim doc so that getHeader() is invoked correctly.

+

Use the --publish flag with nimble to publish docs contained in path to Github in the gh-pages branch. This requires the ghp-import package for Python: pip install ghp-import

+

WARNING: --publish will destroy any existing content in this branch.

+

NOTE: buildDocs() only works correctly on Windows with Nim 1.0+ since https://github.com/nim-lang/Nim/pull/11814 is required.

+ + +
+ +
+ +
+
+ +
+
+ +
+ Made with Nim. Generated: 2020-03-24 20:54:10 UTC +
+
+
+
+ + + -- cgit v1.2.3