g3/g3proxy/doc/README.md
2023-04-04 11:05:51 +08:00

7 lines
282 B
Markdown

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