add user guide

This commit is contained in:
zhangjingqiang 2023-04-04 11:05:51 +08:00
parent d303359fe6
commit caae0c8c03
7 changed files with 555 additions and 41 deletions

7
g3proxy/doc/README.md Normal file
View file

@ -0,0 +1,7 @@
This directory contains the sphinx docs about the configuration & metrics & logs.
To view the docs:
1. [install sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
2. run `make html` in this directory
3. open *_build/html/index.html* with your favourite browser