Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate docs for telemetry events #2855

Open
minrk opened this issue Dec 18, 2019 · 1 comment
Open

Auto-generate docs for telemetry events #2855

minrk opened this issue Dec 18, 2019 · 1 comment

Comments

@minrk
Copy link
Member

minrk commented Dec 18, 2019

It would be pretty handy if the sphinx docs automatically generated content from the jupyter-telemetry event schemas.

Maybe this should even be implemented as a sphinx extension provided by jupyter-telemetry so that any project adopting telemetry could get event docs?

cc @yuvipanda @Zsailer @willingc

@Zsailer
Copy link
Member

Zsailer commented Dec 18, 2019

Totally agree. I've got something basic working in the notebook telemetry PR here. I think you're right, we should make this a sphinx extension.

I'll on this soon and ping here when it's finished.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants