Google Git
Sign in
apache / servicecomb-mesher / 887389aa1c944b231fe9e937bae2043092b5c63b / . / docs
tree: d7affa96c33d0f4a9f917b4dd940f7c064b0de06 [path history] [tgz]
  1. configurations/
  2. development/
  3. getstarted/
  4. images/
  5. intro/
  6. istio/
  7. oauth2/
  8. protocols/
  9. skywalking/
  10. conf.py
  11. configuration.rst
  12. development.rst
  13. get-started.rst
  14. index.rst
  15. intro.rst
  16. istio-guides.rst
  17. make.bat
  18. Makefile
  19. mesher-sidecar.rst
  20. protocols.rst
  21. README.md
  22. sidecar.rst
docs/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

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