Update docs (#1145)

.azure-pipelines-gh-pages.yml

@@ -24,7 +24,7 @@ jobs:
         python3.7 -m venv env
         source env/bin/activate
         pip install wheel
-        pip install -U -r requirements.txt
+        pip install -U -r doc/requirements.txt
         sphinx-multiversion doc build/html
       displayName: Sphinx
 

doc/developers/index.rst

@@ -7,8 +7,6 @@ Applications can be written in C++ or Lua (see :ref:`developers/example:Example
 
 These endpoints mutate the state of a unique :ref:`developers/kv/index:Key-Value Store` that represents the internal state of the application. Applications define a set of ``Maps`` (see :ref:`developers/kv/kv_how_to:Creating a Map`), mapping from a key to a value. When an application endpoint is triggered, the effects on the Store are committed atomically.
 
-.. warning:: Notifications to be described.
-
 .. toctree::
   :maxdepth: 2
   :caption: Contents:

doc/members/member_rpc_api.rst

@@ -68,16 +68,12 @@ withdraw
 getEncryptedRecoveryShare
 -------------------------
 
-.. warning:: Experimental
-
 .. literalinclude:: ../schemas/getEncryptedRecoveryShare_result.json
     :language: json
 
 submitRecoveryShare
 -------------------
 
-.. warning:: Experimental
-
 .. literalinclude:: ../schemas/submitRecoveryShare_params.json
     :language: json
 .. literalinclude:: ../schemas/submitRecoveryShare_result.json

doc/users/rpc_api.rst

@@ -68,6 +68,15 @@ getCommit
 .. literalinclude:: ../schemas/getCommit_result.json
     :language: json
 
+tx
+~~
+
+.. literalinclude:: ../schemas/tx_params.json
+    :language: json
+
+.. literalinclude:: ../schemas/tx_result.json
+    :language: json
+
 getPrimaryInfo
 ~~~~~~~~~~~~~~
 

livehtml.sh

@@ -2,4 +2,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the Apache 2.0 License.
 
-sphinx-autobuild -b html source build/html -H 0.0.0.0
+sphinx-autobuild -b html doc doc/html -H 0.0.0.0

sphinx/source/schemas/tx_params.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "properties": {
-    "seqno": {
-      "maximum": 4294967295,
-      "minimum": 0,
-      "type": "number"
-    },
-    "view": {
-      "maximum": 18446744073709551615,
-      "minimum": 0,
-      "type": "number"
-    }
-  },
-  "required": [
-    "view",
-    "seqno"
-  ],
-  "title": "tx/params",
-  "type": "object"
-}

sphinx/source/schemas/tx_result.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "properties": {
-    "status": {
-      "enum": [
-        "UNKNOWN",
-        "PENDING",
-        "COMMITTED",
-        "INVALID"
-      ]
-    }
-  },
-  "required": [
-    "status"
-  ],
-  "title": "tx/result",
-  "type": "object"
-}