Skip to main content

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.

Metadata

Release files for jupyter-telemetry-sphinxext 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyter-telemetry-sphinxext 0.0.1
File Size Uploaded
jupyter_telemetry_sphinxext-0.0.1.tar.gz 3.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jupyter-telemetry-sphinxext 0.0.1
File Interpreter ABI Platform
jupyter_telemetry_sphinxext-0.0.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 7.8 kB

Release files / jupyter_telemetry_sphinxext-0.0.1.tar.gz

Download URL jupyter_telemetry_sphinxext-0.0.1.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e9e2679f1be4dd38064af6f0f2862f9eda89e0203bf46d12d47a32715a3993cd
BLAKE2b-256 checksum
How to use checksums
fa2c1634e4aa996c509a86220fb193aa80d8e9f5b939b41e547721491d39c8ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.3

Release files / jupyter_telemetry_sphinxext-0.0.1-py2.py3-none-any.whl

Download URL jupyter_telemetry_sphinxext-0.0.1-py2.py3-none-any.whl
Size 3.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
0bd407dfb4d9216782e68fda99f7286058e87438621f3bc6a2a24fb6cd4b804f
BLAKE2b-256 checksum
How to use checksums
bd21cf81d7b06bea0a79aaee71dd8666bdc197c1644507c1f1390519e4f2fb1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page