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