Update docs (#146)

* Update documentation * Fix errors
nlpsandbox · Mar 23, 2021 · b08bed4 · b08bed4
1 parent 3bb3083
commit b08bed4
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 7 deletions.
diff --git a/docs/about/changelog.rst b/docs/about/changelog.rst
@@ -8,6 +8,16 @@ For older releases, visit the `GitHub releases`_.
 
 .. _Github releases: https://github.com/nlpsandbox/nlpsandbox-client/releases
 
+v1.0.0
+------
+- Client uses NLP sandbox API version 1.0.2
+- Update annotate note to accept `Note` instead of `TextAnnotatorRequest` object
+- Update client to support v1.0.2 schemas
+- Change `date`, `person`, `address` to `nlpsandbox:date-annotator`, `nlpsandbox:person-name-annotator` and `nlpsandbox:physical-address-annotator`
+- Add support for `Python` 3.9
+- Add initial unit tests
+- Create `tool` and `datanode` cli modules
+
 v0.4.1
 ------
 - Client uses NLP sandbox API version 1.0.1

diff --git a/docs/cli/nlp-cli.rst b/docs/cli/nlp-cli.rst
@@ -12,6 +12,14 @@ This is the NLP sandbox command line client.
   :prog: nlp-cli community
   :nested: full
 
-.. click:: nlpsandboxclient.cli.evaluate:cli
-  :prog: nlp-cli evaluate
-  :nested: full
+.. click:: nlpsandboxclient.cli.evaluate:evaluate_prediction
+  :prog: nlp-cli evaluate-prediction
+  :nested: full
+
+.. click:: nlpsandboxclient.cli.datanode_cli:cli
+  :prog: nlp-cli datanode
+  :nested: full
+
+.. click:: nlpsandboxclient.cli.tool:cli
+  :prog: nlp-cli tool
+  :nested: full
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 author = 'Thomas Yu'
 
 # The short X.Y version
-version = '0.4.1'
+version = '1.0'
 # The full version, including alpha/beta/rc tags
 release = version
 

diff --git a/docs/python/client.rst b/docs/python/client.rst
@@ -10,4 +10,9 @@ nlpsandboxclient
 .. automodule:: nlpsandboxclient.utils
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:
+
+.. automodule:: nlpsandboxclient.evaluation
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 pandas==1.0.1
-synapseclient==2.2.2
+synapseclient==2.3.0
 nlpsandbox-client
 sphinx_rtd_theme
 sphinx-click
diff --git a/nlpsandboxclient/cli/datanode_cli.py b/nlpsandboxclient/cli/datanode_cli.py
@@ -137,7 +137,7 @@ def store_dataset(data_node_host, dataset_id, output):
               default=DATA_NODE_HOST, show_default=True)
 @click.option('--dataset_id', help='Dataset id', required=True)
 def delete_dataset(data_node_host, dataset_id):
-    """Create a dataset in the data node"""
+    """Delete a dataset in the data node"""
     # Create dataset
     client.delete_dataset(host=data_node_host,
                           dataset_id=dataset_id)