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