Metadata-Version: 2.1
Name: jupyter-telemetry-sphinxext
Version: 0.0.1
Summary: Sphinx extension for auto-generating Jupyter Telemetry schema documentation.
Home-page: https://github.com/Zsailer/jupyter_telemetry_sphinxext
Author: Jupyter Development Team
Author-email: jupyter@googlegroups.com
License: BSD
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5.0
Description-Content-Type: text/markdown
Requires-Dist: jupyter-telemetry
Requires-Dist: sphinx-jsonschema


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

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

