Migrate docs to use poetry (#326)

* migrated docs to use poetry, removed python browser script from makefile

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

* bumped version in version.py

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

* updated changelog

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

---------

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

CHANGELOG.md

@@ -28,6 +28,7 @@ For reference, the possible headings are:
 ## [2.2.4] - 2023-15-02
 * **Changed** migrated dependency management to poetry
 * **Removed** removed unused text_search related code
+* **Changed** docs are now built using poetry
 
 ## [2.2.3] - 2023-14-02
 * **Fixed** fixed voting/election backward compatibility issue (using planetmint-transactions >= 0.7.0) on the 2.2 main branch

Makefile

@@ -3,21 +3,6 @@
 .DEFAULT_GOAL := help
 
 
-#############################
-# Open a URL in the browser #
-#############################
-define BROWSER_PYSCRIPT
-import os, webbrowser, sys
-try:
-	from urllib import pathname2url
-except:
-	from urllib.request import pathname2url
-
-webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
-endef
-export BROWSER_PYSCRIPT
-
-
 ##################################
 # Display help for this makefile #
 ##################################
@@ -42,7 +27,6 @@ export PRINT_HELP_PYSCRIPT
 ##################
 DOCKER := docker
 DC := docker-compose
-BROWSER := python -c "$$BROWSER_PYSCRIPT"
 HELP := python -c "$$PRINT_HELP_PYSCRIPT"
 ECHO := /usr/bin/env echo
 
@@ -100,15 +84,9 @@ test-integration: check-deps ## Run all integration tests
 
 cov: check-deps ## Check code coverage and open the result in the browser
 	@$(DC) run --rm planetmint pytest -v --cov=planetmint --cov-report html
-	$(BROWSER) htmlcov/index.html
 
 docs: check-deps ## Generate HTML documentation and open it in the browser
 	@$(DC) run --rm --no-deps bdocs make -C docs/root html
-	$(BROWSER) docs/root/build/html/index.html
-
-docs-integration: check-deps ## Create documentation for integration tests
-	@$(DC) run --rm python-integration pycco -i -s /src -d /docs
-	$(BROWSER) integration/python/docs/index.html
 
 clean: check-deps ## Remove all build, test, coverage and Python artifacts
 	@$(DC) up clean

docker-compose.yml

@@ -96,7 +96,7 @@ services:
       context: .
       dockerfile: Dockerfile
       args:
-        backend: tarantool
+        backend: tarantool_db
     volumes:
       - .:/usr/src/app/
     command: make -C docs/root html

docs/root/Makefile

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

docs/root/requirements.txt

@@ -1,46 +0,0 @@
-aafigure==0.6
-alabaster==0.7.12
-Babel==2.10.1
-certifi==2022.12.7
-charset-normalizer==2.0.12
-commonmark==0.9.1
-docutils==0.17.1
-idna
-imagesize==1.3.0
-importlib-metadata==4.11.3
-Jinja2==3.0.0
-markdown-it-py==2.1.0
-MarkupSafe==2.1.1
-mdit-py-plugins==0.3.0
-mdurl==0.1.1
-myst-parser==0.17.2
-packaging==21.3
-pockets==0.9.1
-Pygments==2.12.0
-pyparsing==3.0.8
-pytz==2022.1
-PyYAML>=5.4.0
-requests>=2.25i.1
-six==1.16.0
-snowballstemmer==2.2.0
-Sphinx==4.5.0
-sphinx-rtd-theme==1.0.0
-sphinxcontrib-applehelp==1.0.2
-sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.0
-sphinxcontrib-httpdomain==1.8.0
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-napoleon==0.7
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.5
-urllib3==1.26.9
-wget==3.2
-zipp==3.8.0
-nest-asyncio==1.5.5
-sphinx-press-theme==0.8.0
-sphinx-documatt-theme
-base58>=2.1.1
-pynacl==1.4.0
-zenroom==2.1.0.dev1655293214
-pyasn1==0.4.8
-cryptography==3.4.7

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

@@ -4,7 +4,7 @@ Content-Type: application/json
 {
   "assets": "/assets/",
   "blocks": "/blocks/",
-  "docs": "https://docs.planetmint.io/projects/server/en/v1.4.1/http-client-server-api.html",
+  "docs": "https://docs.planetmint.io/projects/server/en/v2.2.4/http-client-server-api.html",
   "metadata": "/metadata/",
   "outputs": "/outputs/",
   "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",

docs/root/source/connecting/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.io/projects/server/en/v1.4.1/http-client-server-api.html",
+      "docs": "https://docs.planetmint.io/projects/server/en/v2.2.4/http-client-server-api.html",
       "metadata": "/api/v1/metadata/",
       "outputs": "/api/v1/outputs/",
       "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",
@@ -15,7 +15,7 @@ Content-Type: application/json
       "validators": "/api/v1/validators"
     }
   },
-  "docs": "https://docs.planetmint.io/projects/server/en/v1.4.1/",
+  "docs": "https://docs.planetmint.io/projects/server/en/v2.2.4/",
   "software": "Planetmint",
-  "version": "1.4.1"
+  "version": "2.2.4"
 }

planetmint/version.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
 # Code is Apache-2.0 and docs are CC-BY-4.0
 
-__version__ = "2.2.3"
+__version__ = "2.2.4"
 __short_version__ = "2.2"
 
 # Supported Tendermint versions