Developer Guide

Additional Developer prerequisites

Sphinx tool

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 docs folder.

  • 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 ( 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 is designed to aid in the development and testing of Ansible roles. In BAF, Molecule is used to check for common coding standards, yaml errors and unit testing Ansible code/roles.

  • Molecule version used 2.22


  • Docker Engine
  • Python3 (and pip configured with python3)

Molecule installation 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.

$ 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.

Jenkins Automation