This directory holds the code that read the code of the mixt module, its docstring, typing annotations, etc, and render an HTML doc using mixt components created on purpose.
pip install mixt[doc]
To render the html/css/js files in a directory
python -m api_doc.export directory
The final directory where the doc have to be exported is docs
.
It can be done with:
make doc
To server the html content on localhost:8080
:
python -m api_doc.serve