Investin's documentation is build using MkDocs and the beautiful Material for MkDocs theme. In order to create Investin's documentation you have to install them:
pip install mkdocs mkdocs-material
Be sure that your installed version of Markdown>=3.0.1
.
Then generate api.md
from source (from the src
directory):
python code_doc_autogen.py
Test it (from the src
directory):
mkdocs serve
Finally build the static website (from the src
directory):
mkdocs build
It will create the static website in $Investin/docs/
.