Skip to content

Feature Request: Link API docs to PyMC-Examples that use the classes/methods #6542

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

Open
ricardoV94 opened this issue Feb 22, 2023 · 1 comment

Comments

@ricardoV94
Copy link
Member

ricardoV94 commented Feb 22, 2023

Description

I don't know if this can be automated in any way, but it would be nice that when you go to https://www.pymc.io/projects/docs/en/stable/api/distributions/generated/pymc.Censored.html, it would show links to relevant notebooks like https://www.pymc.io/projects/examples/en/latest/generalized_linear_models/GLM-truncated-censored-regression.html

Or the relevant tag? https://www.pymc.io/projects/examples/en/latest/blog/tag/censored.html

@OriolAbril
Copy link
Member

OriolAbril commented Feb 27, 2023

There already is a proof of concept for this: https://www.pymc.io/projects/examples/en/latest/object_index/index.html. We need to list things manually the first time like it happens with our api docs, but the listing of actual examples is completely automated, see for example: https://www.pymc.io/projects/examples/en/latest/object_index/distributions/continuous.html. We would only need to link from api docs to the right section (might be even possible to automate)

I don't think it makes sense to work too much on this until we have closed #5282 though, as many of the sections are quite strange (in addition to the missing things). After that it would be only a matter of copying the reviewed hierarchy over.

We could start with distributions already for example as that section probably won't change much? And it is one of the main things people will want to see

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

2 participants