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