Skip to main content

Sphinx extension for auto-generating Jupyter Telemetry schema documentation.

Project description

Jupyter Telemetry Sphinx Extension

Sphinx extension for auto-generating Jupyter Telemetry schema documentation.

To activate this extension, add jupyter_telemetry_sphinxext to your conf.py file and set the following configuration values:

# 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.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyter-telemetry-sphinxext, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size jupyter_telemetry_sphinxext-0.0.1-py2.py3-none-any.whl (3.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size jupyter_telemetry_sphinxext-0.0.1.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page