跳转到主要内容

Sphinx扩展,用于自动生成Jupyter Telemetry模式文档。

项目描述

Jupyter Telemetry Sphinx扩展

Sphinx扩展,用于自动生成Jupyter Telemetry模式文档。

要激活此扩展,将 jupyter_telemetry_sphinxext 添加到您的 conf.py 文件,并设置以下配置值

# config.py file.
# Add jupyter_telemetry_sphinxext to the extensions list.
extensions = [
    'jupyter_telemetry_sphinxext',
    ...
]

# Jupyter telemetry configuration values.
jupyter_telemetry_schema_source = "path/to/schemas/source/directory"   # Path is relative to conf.py
jupyter_telemetry_schema_output = "path/to/output/directory"           # Path is relative to conf.py
jupyter_telemetry_index_title = "Example Event Schemas"                # Title of the index page that lists all found schemas.

由以下支持