Skip to main content

Docs Generation

This repository includes small offline scripts to extract code references for documentation.

  • scripts/docs_extract/symbol_index.py generates the symbol index.
  • scripts/docs_extract/http_api.py generates the HTTP routes table.
  • scripts/docs_extract/config_reference.py generates the configuration reference.

Code: scripts/docs_extract/symbol_index.py:main, scripts/docs_extract/http_api.py:main, scripts/docs_extract/config_reference.py:main

Usage​

python scripts/docs_extract/symbol_index.py
python scripts/docs_extract/http_api.py
python scripts/docs_extract/config_reference.py

Code: scripts/docs_extract/symbol_index.py:main, scripts/docs_extract/http_api.py:main, scripts/docs_extract/config_reference.py:main