We use Sphinx to build our documentation.
Before you start, be sure to install our version of Sphinx:
pip install git+https://github.com/valisj/sphinx
pip install git+https://github.com/valisj/sphinxcontrib-fulltoc
This requires pip to be installed on your system. To install pip, follow the installation instructions on their official documentation.
Clone the repository:
git clone https://github.com/transfer-framework/docs.git
Run the following command in the project root folder to build the documentation in HTML format:
make html
Then, open _build/html/index.html in your browser.