How to write doc in local
Prepare
- Install Python 3.X
- Install pip3
- Install sphinx(>=2.0.0) support https://docs.readthedocs.io/en/latest/getting_started.html
- Install RTD module & recommonmark
sudo pip install sphinx_rtd_theme
sudo pip install recommonmark
Generate doc
In windows
cd docs
make.bat html
In linux
cd docs
make html
Check the result
- See html pages in _build folder
cd _build/html
- You can start a http server using
python -m http.server
which will serve at http://127.0.0.1:8000/.