docs update

will-rowe · May 5, 2020 · 3f1429b · 3f1429b
1 parent 1fe7173
commit 3f1429b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,9 +30,9 @@
 author = 'Will Rowe'
 
 # The short X.Y version
-version = '1.0'
+version = '1.1'
 # The full version, including alpha/beta/rc tags
-release = '1.0.2'
+release = '1.1.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -79,8 +79,11 @@
 #
 html_theme = 'bootstrap'
 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+
 def setup(app):
-    app.add_stylesheet("my-styles.css") # also can be a full URL
+    app.add_stylesheet("my-styles.css")  # also can be a full URL
+
 
 html_logo = "groot-logo.png"
 html_theme_options = {

diff --git a/docs/using-groot.md b/docs/using-groot.md
@@ -91,6 +91,7 @@ Some more flags that can be used:
 - `-s`: size of MinHash sketch
 - `-x`: number of partitions in the LSH Ensemble index
 - `-y`: maxK in the LSH Ensemble index
+- `--maxSketchSpan`: max number of identical neighbouring sketches permitted in any graph traversal
 
 > Important: GROOT can only accept MSAs as input. You can cluster your own database or use `groot get` to obtain a pre-clustered one.