fixed docs to pass the build (#107)

* fixed docs to pass the build

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

* fixed docs building issue

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

* removed obsolete deps

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

* fixed missing reference issue

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

* removed warning as error and redo a previous fix

Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>

docs/root/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -W
+SPHINXOPTS    = 
 SPHINXBUILD   = sphinx-build
 PAPER         = a4
 BUILDDIR      = build

docs/root/requirements.txt

@@ -5,7 +5,7 @@ certifi==2021.10.8
 charset-normalizer==2.0.12
 commonmark==0.9.1
 docutils==0.17.1
-idna==3.3
+idna
 imagesize==1.3.0
 importlib-metadata==4.11.3
 Jinja2==3.0.0
@@ -19,9 +19,8 @@ pockets==0.9.1
 Pygments==2.12.0
 pyparsing==3.0.8
 pytz==2022.1
-PyYAML==6.0
-recommonmark==0.7.1
-requests==2.27.1
+PyYAML>=5.4.0
+requests>=2.25i.1
 six==1.16.0
 snowballstemmer==2.2.0
 Sphinx==4.5.0
@@ -34,7 +33,6 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-napoleon==0.7
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
-typing-extensions==4.2.0
 urllib3==1.26.9
 wget==3.2
 zipp==3.8.0

docs/root/source/installation/api/http-samples/api-index-response.http

@@ -4,7 +4,7 @@ Content-Type: application/json
 {
   "assets": "/assets/",
   "blocks": "/blocks/",
-  "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html",
+  "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/http-client-server-api.html",
   "metadata": "/metadata/",
   "outputs": "/outputs/",
   "streams": "ws://localhost:9985/api/v1/streams/valid_transactions",

docs/root/source/installation/api/http-samples/index-response.http

@@ -6,7 +6,7 @@ Content-Type: application/json
     "v1": {
       "assets": "/api/v1/assets/",
       "blocks": "/api/v1/blocks/",
-      "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/http-client-server-api.html",
+      "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/http-client-server-api.html",
       "metadata": "/api/v1/metadata/",
       "outputs": "/api/v1/outputs/",
       "streams": "ws://localhost:9985/api/v1/streams/valid_transactions",
@@ -14,7 +14,7 @@ Content-Type: application/json
       "validators": "/api/v1/validators"
     }
   },
-  "docs": "https://docs.planetmint.com/projects/server/en/v0.9.1/",
+  "docs": "https://docs.planetmint.com/projects/server/en/v0.9.2/",
   "software": "Planetmint",
-  "version": "0.9.1"
+  "version": "0.9.2"
 }

docs/root/source/properties.md

@@ -7,7 +7,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
 
 # Properties of Planetmint 
 
-### Decentralization
+## Decentralization
 
 Decentralization means that no one owns or controls everything, and there is no single point of failure.
 
@@ -23,12 +23,12 @@ If someone has (or gets) admin access to a node, they can mess with that node (e
 
 It’s worth noting that not even the admin or superuser of a node can transfer assets. The only way to create a valid transfer transaction is to fulfill the current crypto-conditions on the asset, and the admin/superuser can’t do that because the admin user doesn’t have the necessary information (e.g. private keys).
 
-### Byzantine Fault Tolerance
+## Byzantine Fault Tolerance
 
 [Tendermint](https://tendermint.io/) is used for consensus and transaction replication,
 and Tendermint is [Byzantine Fault Tolerant (BFT)](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance).
 
-### Node Diversity
+## Node Diversity
 
 Steps should be taken to make it difficult for any one actor or event to control or damage “enough” of the nodes. (Because Planetmint Server uses Tendermint, "enough" is ⅓.) There are many kinds of diversity to consider, listed below. It may be quite difficult to have high diversity of all kinds.
 
@@ -39,7 +39,7 @@ Steps should be taken to make it difficult for any one actor or event to control
 
 Note: If all the nodes are running the same code, i.e. the same implementation of Planetmint, then a bug in that code could be used to compromise all of the nodes. Ideally, there would be several different, well-maintained implementations of Planetmint Server (e.g. one in Python, one in Go, etc.), so that a consortium could also have a diversity of server implementations. Similar remarks can be made about the operating system.
 
-### Immutability
+## Immutability
 
 The blockchain community often describes blockchains as “immutable.” If we interpret that word literally, it means that blockchain data is unchangeable or permanent, which is absurd. The data _can_ be changed. For example, a plague might drive humanity extinct; the data would then get corrupted over time due to water damage, thermal noise, and the general increase of entropy.
 

docs/root/source/terminology.md

@@ -9,17 +9,17 @@ Code is Apache-2.0 and docs are CC-BY-4.0
 
 There is some specialized terminology associated with Planetmint. To get started, you should at least know the following:
 
-### Planetmint Node
+## Planetmint Node
 
 **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
+## Planetmint Network
 
 A set of Planetmint nodes can connect to each other to form a **Planetmint network**. Each node in the network runs the same software. A Planetmint network may have additional machines to do things such as  monitoring.
 
-### Planetmint Consortium
+## Planetmint Consortium
 
 The people and organizations that run the nodes in a Planetmint network belong to a **Planetmint consortium** (i.e. another organization). A consortium must have some sort of governance structure to make decisions. If a Planetmint network is run by a single company, then the "consortium" is just that company.
 
@@ -27,7 +27,7 @@ The people and organizations that run the nodes in a Planetmint network belong t
 
 A Planetmint network is just a bunch of connected nodes. A consortium is an organization which has a Planetmint network, and where each node in that network has a different operator.
 
-### Transactions
+## Transactions
 
 Are described in detail in `Planetmint Transactions Spec <https://github.com/planetmint/BEPs/tree/master/tx-specs/>`_ .
 

setup.py

@@ -35,6 +35,15 @@ def check_setuptools_features():
                  ' $ pip3 install --upgrade setuptools\n'
                  'and then run this command again')
 
+import pathlib
+import pkg_resources
+
+with pathlib.Path('docs/root/requirements.txt').open() as requirements_txt:
+    docs_require= [
+        str(requirement)
+        for requirement
+        in pkg_resources.parse_requirements(requirements_txt)
+    ]
 
 check_setuptools_features()
 
@@ -47,17 +56,6 @@ dev_require = [
     'twine'
 ]
 
-docs_require = [
-    'Sphinx~=1.0',
-    'recommonmark>=0.4.0',
-    'sphinx-rtd-theme>=0.1.9',
-    'sphinxcontrib-httpdomain>=1.5.0',
-    'sphinxcontrib-napoleon>=0.4.4',
-    'aafigure>=0.6',
-    'wget',
-    'jinja2==3.0.0'
-]
-
 tests_require = [
     'coverage',
     'pep8',

tox.ini

@@ -35,5 +35,5 @@ deps =
     typing-extensions
     -r{toxinidir}/docs/root/requirements.txt
 extras = None
-commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+commands = sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html