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

Link in sphinx-gallery tutorials link to traitlets base class, not to ctapipe implementation #2471

Closed
maxnoe opened this issue Nov 23, 2023 · 0 comments · Fixed by #2572
Closed
Assignees
Milestone

Comments

@maxnoe
Copy link
Member

maxnoe commented Nov 23, 2023

Describe the bug

If you go to e.g.:
https://ctapipe.readthedocs.io/en/latest/auto_examples/tutorials/calibrated_data_exploration.html
you see that sphinx-gallery creates cross-links from the code examples to documentation for classes.

Some classes. Only configuragbles. And the links don't point to the implementation of the specific class in ctapipe but to the
traitlets.config.Configurable base class in the traitlets docs.

To Reproduce

Go to the above link and check.

Expected behavior

Link all ctapipe imports and link to the correct class, not the external base class.

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

Successfully merging a pull request may close this issue.

2 participants