tree: 5018fbfe884a3633457713a202cbe1e21865a084 [path history] [tgz]
  1. design-guides/
  2. dev-guides/
  3. get-started/
  4. intro/
  5. openapi/
  6. plugins-tracing/
  7. release/
  8. user-guides/
  9. conf.py
  10. design-guides.rst
  11. dev-guides.rst
  12. get-started.rst
  13. index.rst
  14. intro.rst
  15. make.bat
  16. Makefile
  17. plugin-tracing-guides.rst
  18. README.md
  19. release.rst
  20. Service-Center-UI-Preview.gif
  21. 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
cd _build/html
  1. You can start a http server using python -m http.server which will serve at http://127.0.0.1:8000/.