From af7ee8ea5bd103f185b5e6453ac07b084c1c4953 Mon Sep 17 00:00:00 2001 From: emotemot Date: Fri, 22 Apr 2022 10:27:51 +0300 Subject: [PATCH 1/3] build changes --- docs/root/generate_http_server_api_documentation.py | 4 ++++ .../installation/api/http-samples/api-index-response.http | 4 ++++ .../installation/api/http-samples/index-response.http | 8 ++++++++ 3 files changed, 16 insertions(+) diff --git a/docs/root/generate_http_server_api_documentation.py b/docs/root/generate_http_server_api_documentation.py index 1bf66ae..a3a94e6 100644 --- a/docs/root/generate_http_server_api_documentation.py +++ b/docs/root/generate_http_server_api_documentation.py @@ -9,8 +9,12 @@ import json import os import os.path +<<<<<<< Updated upstream from planetmint.transactions.common.input import Input from planetmint.transactions.common.transaction_link import TransactionLink +======= +from planetmint.common.transaction import Transaction, Input, TransactionLink +>>>>>>> Stashed changes from planetmint import lib from planetmint.transactions.types.assets.create import Create from planetmint.transactions.types.assets.transfer import Transfer diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index 7ba7be8..e92cb2f 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,7 +4,11 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", +>>>>>>> Stashed changes "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index c593a91..1eff019 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,7 +6,11 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", +>>>>>>> Stashed changes "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -14,7 +18,11 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, +<<<<<<< Updated upstream "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/", +======= + "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/", +>>>>>>> Stashed changes "software": "Planetmint", "version": "0.9.0" } From ee504a0547181adb7f8727ad545359a35fa276f8 Mon Sep 17 00:00:00 2001 From: emotemot Date: Mon, 2 May 2022 14:58:47 +0300 Subject: [PATCH 2/3] updated .yml --- .readthedocs.yml | 35 ++++++++++++++++--- .../generate_http_server_api_documentation.py | 4 --- .../api/http-samples/api-index-response.http | 6 +--- .../api/http-samples/index-response.http | 14 ++------ docs/root/source/terminology.md | 13 +++---- 5 files changed, 39 insertions(+), 33 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2ccc3f9..e2f0dfb 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,9 +3,36 @@ # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) # Code is Apache-2.0 and docs are CC-BY-4.0 -build: - image: latest +#build: +# image: latest +#python: +# version: 3.9 +# pip_install: true + + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "16" + # rust: "1.55" + # golang: "1.17" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs python: - version: 3.9 - pip_install: true + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/root/generate_http_server_api_documentation.py b/docs/root/generate_http_server_api_documentation.py index a3a94e6..1bf66ae 100644 --- a/docs/root/generate_http_server_api_documentation.py +++ b/docs/root/generate_http_server_api_documentation.py @@ -9,12 +9,8 @@ import json import os import os.path -<<<<<<< Updated upstream from planetmint.transactions.common.input import Input from planetmint.transactions.common.transaction_link import TransactionLink -======= -from planetmint.common.transaction import Transaction, Input, TransactionLink ->>>>>>> Stashed changes from planetmint import lib from planetmint.transactions.types.assets.create import Create from planetmint.transactions.types.assets.transfer import Transfer diff --git a/docs/root/source/installation/api/http-samples/api-index-response.http b/docs/root/source/installation/api/http-samples/api-index-response.http index e92cb2f..601f9ef 100644 --- a/docs/root/source/installation/api/http-samples/api-index-response.http +++ b/docs/root/source/installation/api/http-samples/api-index-response.http @@ -4,11 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", diff --git a/docs/root/source/installation/api/http-samples/index-response.http b/docs/root/source/installation/api/http-samples/index-response.http index 1eff019..f7e524e 100644 --- a/docs/root/source/installation/api/http-samples/index-response.http +++ b/docs/root/source/installation/api/http-samples/index-response.http @@ -6,11 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streams": "ws://localhost:9985/api/v1/streams/valid_transactions", @@ -18,11 +14,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, -<<<<<<< Updated upstream - "docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/", -======= - "docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/", ->>>>>>> Stashed changes + "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/", "software": "Planetmint", - "version": "0.9.0" + "version": "0.9.1" } diff --git a/docs/root/source/terminology.md b/docs/root/source/terminology.md index 6f42b32..8c51eca 100644 --- a/docs/root/source/terminology.md +++ b/docs/root/source/terminology.md @@ -11,11 +11,9 @@ There is some specialized terminology associated with Planetmint. To get started ### Planetmint Node -<<<<<<< HEAD -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. -======= -A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. + +**Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.io/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization. ### Planetmint Network @@ -80,10 +78,7 @@ You could do more elaborate things too. As one example, each time someone writes ### Role-Based Access Control (RBAC) -<<<<<<< HEAD In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997). -======= -In September 2017, BigchainDB published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.bigchaindb.com/role-based-access-control-for-planetmint-assets-b7cada491997). ->>>>>>> 3bfc3298f8210b135084e823eedd47f213538088 + At the time of writing (January 2018), doing so required the use of a plugin, so it's not possible using standard Planetmint (which is what's available on the [IPDB Testnet](https://test.ipdb.io/>). That may change in the future. If you're interested, `contact IPDB `_. From a9655629197f720587c7360764223244621c4bda Mon Sep 17 00:00:00 2001 From: emotemot Date: Mon, 2 May 2022 15:44:19 +0300 Subject: [PATCH 3/3] requirements.txt updated --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e2f0dfb..9819c43 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -35,4 +35,4 @@ sphinx: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/root/requirements.txt \ No newline at end of file