docs(docs): documenter

compbiocore · Mar 2, 2019 · 4a53383 · 4a53383
1 parent 40c88f9
commit 4a53383
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -29,3 +29,4 @@ pages:
 - Manual:
   - Read and Filter VCF: filtering_vcf.md
   - Heatmaps: plotting.md
+- API: api.md
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -0,0 +1,18 @@
+##Import
+
+```
+using VIVA
+```
+
+## Index
+
+```@index
+Modules = [VIVA]
+```
+
+## Functions
+
+```@autodocs
+Modules = [VIVA]
+Order   = [:function, :type]
+```