diff --git a/.azure-pipelines-gh-pages.yml b/.azure-pipelines-gh-pages.yml index ad4be5c8e..c111c4062 100644 --- a/.azure-pipelines-gh-pages.yml +++ b/.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 diff --git a/doc/developers/index.rst b/doc/developers/index.rst index 3c1790e3a..033cb2863 100644 --- a/doc/developers/index.rst +++ b/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: diff --git a/doc/members/member_rpc_api.rst b/doc/members/member_rpc_api.rst index 00ae8efb6..7c4c34fee 100644 --- a/doc/members/member_rpc_api.rst +++ b/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 diff --git a/requirements.txt b/doc/requirements.txt similarity index 100% rename from requirements.txt rename to doc/requirements.txt diff --git a/doc/users/rpc_api.rst b/doc/users/rpc_api.rst index 256efbfa0..ef1d0de65 100644 --- a/doc/users/rpc_api.rst +++ b/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 ~~~~~~~~~~~~~~ diff --git a/livehtml.sh b/livehtml.sh index b1224bf86..d999ef8e1 100755 --- a/livehtml.sh +++ b/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 \ No newline at end of file +sphinx-autobuild -b html doc doc/html -H 0.0.0.0 \ No newline at end of file diff --git a/sphinx/source/schemas/tx_params.json b/sphinx/source/schemas/tx_params.json deleted file mode 100644 index 19580e209..000000000 --- a/sphinx/source/schemas/tx_params.json +++ /dev/null @@ -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" -} \ No newline at end of file diff --git a/sphinx/source/schemas/tx_result.json b/sphinx/source/schemas/tx_result.json deleted file mode 100644 index 2b5a3450a..000000000 --- a/sphinx/source/schemas/tx_result.json +++ /dev/null @@ -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" -} \ No newline at end of file