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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for jupyter_telemetry_sphinxext-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9e2679f1be4dd38064af6f0f2862f9eda89e0203bf46d12d47a32715a3993cd |
|
MD5 | c76d76cfe53b619f374c2209dbb276c1 |
|
BLAKE2b-256 | fa2c1634e4aa996c509a86220fb193aa80d8e9f5b939b41e547721491d39c8ad |
Close
Hashes for jupyter_telemetry_sphinxext-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bd407dfb4d9216782e68fda99f7286058e87438621f3bc6a2a24fb6cd4b804f |
|
MD5 | fc5f9c76b948f15f0729909c7c4d60a6 |
|
BLAKE2b-256 | bd21cf81d7b06bea0a79aaee71dd8666bdc197c1644507c1f1390519e4f2fb1c |