g3/sphinx/g3proxy
2025-06-22 17:11:57 +08:00
..
_static move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
_templates move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
configuration g3-statsd-client: switch to use batch udp sendmsg when possible 2025-06-22 17:11:57 +08:00
log g3proxy: do full duplex transfer of stream at shutdown 2025-03-05 18:47:27 +08:00
metrics g3proxy: update sphinx doc 2025-06-20 11:53:59 +08:00
protocol update sphinx doc 2025-05-18 22:10:46 +08:00
.gitignore move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
conf.py rename stat config option emit_duration to emit_interval 2025-06-16 11:28:25 +08:00
index.rst g3keymess: add sphinx doc 2025-04-28 15:22:03 +08:00
make.bat move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
Makefile move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
README.md move sphinx together and support to upload to Read the Docs (#411) 2024-12-03 12:51:57 +08:00
requirements.txt add sphinx CI job 2024-12-08 15:26:53 +08:00

This directory contains the sphinx docs about the configuration & metrics & logs for g3proxy.

To view the docs:

  1. install sphinx
  2. run make html in this directory
  3. open _build/html/index.html with your favourite browser