tree: 7580fd290bf4fd85978e1a17ac3f6e370a56e123 [path history] [tgz]
  1. design-guides/
  2. dev-guides/
  3. get-started/
  4. intro/
  5. plugins-tracing/
  6. release/
  7. user-guides/
  8. conf.py
  9. design-guides.rst
  10. dev-guides.rst
  11. get-started.rst
  12. index.rst
  13. intro.rst
  14. make.bat
  15. Makefile
  16. plugin-tracing-guides.rst
  17. README.md
  18. release.rst
  19. Service-Center-UI-Preview.gif
  20. user-guides.rst
docs/README.md

How to write doc in local

Prepare

  1. Install Python 3.X
  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/.