625a8f89fe
* add strcture change * add change in index * add change to index.rst * revice the document * add icons * revise on the pages * add readme update * remove ood information * change title |
||
|---|---|---|
| .. | ||
| _build | ||
| image | ||
| source | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements-doc.txt | ||
| requirements-rtd.txt | ||
Analytics-zoo-doc Documentation
To compile the documentation, run the following commands from this directory.
pip install -r requirements-doc.txt
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
make html
open _build/html/index.html
To test if there are any build errors with the documentation, do the following.
sphinx-build -b html -d _build/doctrees source _build/html