Additional Developer prerequisites¶
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.
This tool is needed to build the Blockchain Automation Framework documentation from
- Sphinx version used 2.1.1
Sphinx installation: Follow the link to install sphinx documentation tool.
All the Blockchain Automation Framework documentation and Sphinx Configuration files (
conf.py) are located in docs/source folder.
To build the documentation, execute the following command from docs directory:
make html # or for Windows .\Make.bat html
- Molecule version used 2.22
- Docker Engine
- Python3 (and pip configured with python3)
Please refer to the Virtual environment documentation for installation best
practices. If not using a virtual environment, please consider passing the
widely recommended ‘–user’ flag when invoking
$ pip install --user 'molecule[docker]'
The existing test scenarios are found in the molecule folder under configuration of each platform e.g. platforms/shared/configuration/molecule folder.