Name		Name	Last commit message	Last commit date
parent directory ..
design-guides		design-guides
dev-guides		dev-guides
discovery		discovery
getstarted		getstarted
huawei		huawei
intro		intro
istio		istio
middleware		middleware
plugins-config		plugins-config
plugins-tracing		plugins-tracing
protocol-plugins		protocol-plugins
user-guides		user-guides
Makefile		Makefile
README.md		README.md
conf.py		conf.py
design-guides.rst		design-guides.rst
dev-guides.rst		dev-guides.rst
discovery-guides.rst		discovery-guides.rst
get-started.rst		get-started.rst
huawei-guides.rst		huawei-guides.rst
index.rst		index.rst
intro.rst		intro.rst
istio-guides.rst		istio-guides.rst
make.bat		make.bat
middleware.rst		middleware.rst
plugin-tracing-guides.rst		plugin-tracing-guides.rst
protocol-plugins.rst		protocol-plugins.rst
user-guides.rst		user-guides.rst

README.md

How to write doc in local

Prepare

Install Python 2.7 with zlib, libssl-dev(openssl-devel)
Install pip
Install readthe doc support https://docs.readthedocs.io/en/latest/getting_started.html
Install RTD module

sudo pip install sphinx_rtd_theme

Generate doc

In windows

pip install recommonmark
cd docs
make.bat html

In linux

cd docs
sphinx-autobuild . _build/html

Check the result

See html pages in _build folder
Access https://127.0.0.1:8000