tree: 01f9a0f484106ed5d686d7aa5714ec190a0ac3e0 [path history] [tgz]
  1. configurations/
  2. getstarted/
  3. images/
  4. intro/
  5. istio/
  6. protocols/
  7. conf.py
  8. configuration.rst
  9. get-started.rst
  10. index.rst
  11. intro.rst
  12. istio-guides.rst
  13. make.bat
  14. Makefile
  15. mesher-sidecar.rst
  16. protocols.rst
  17. README.md
  18. 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