README.md

How to write doc in local

Prepare

1. Install Python 2.7 with zlib, libssl-dev(openssl-devel)
2. Install pip
3. Install readthe doc support https://docs.readthedocs.io/en/latest/getting_started.html
4. Install RTD module

sudo pip install sphinx_rtd_theme

Generate doc

In windows

pip install recommonmark
cd docs
make.bat html

In linux

cd docs
sphinx-autobuild . _build/html

Check the result

1. See html pages in _build folder
2. Access http://127.0.0.1:8000