tree: 08e397bc313b66607739da26e4c76a20a5c0d04d [path history] [tgz]
  1. Makefile
  2. README.md
  3. conf.py
  4. configuration.rst
  5. configurations/
  6. development-guide.rst
  7. development-guide/
  8. get-started.rst
  9. getstarted/
  10. images/
  11. index.rst
  12. intro.rst
  13. intro/
  14. make.bat
docs/README.md

How to write doc in local

Prepare

  1. Install Python 3.X with zlib, libssl-dev(openssl-devel)
  2. Install pip3
  3. Install sphinx(>=2.0.0) support https://docs.readthedocs.io/en/latest/getting_started.html
  4. 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

  1. See html pages in _build folder
  2. You can start a http server using python -m http.server which will serve at http://0.0.0.0:8000/.