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.

Sign up for GitHub

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

Jump to bottom

Embed intersphinx links in code snippets #106

Closed
redeboer opened this issue Jan 30, 2022 · 0 comments · Fixed by ComPWA/ampform#217, ComPWA/tensorwaves#405, ComPWA/qrules#147, ComPWA/PWA-pages#158 or #107
Closed

Embed intersphinx links in code snippets #106

redeboer opened this issue Jan 30, 2022 · 0 comments · Fixed by ComPWA/ampform#217, ComPWA/tensorwaves#405, ComPWA/qrules#147, ComPWA/PWA-pages#158 or #107
Assignees
@redeboer
Labels
📝 Docs Improvements or additions to documentation

Comments

@redeboer
Copy link
Member

redeboer commented Jan 30, 2022 •
edited
Loading

Matplotlib's documentation has API-links in code blocks, see for instance here:
image

This would be an awesome upgrade to the docs, as it removes the need to provide links to the relevant classes and functions in the surrounding text.

Some solutions:
@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Jan 30, 2022
@redeboer redeboer self-assigned this Jan 30, 2022
This was referenced Jan 30, 2022
Merged
Merged
Merged
Merged
Merged
@redeboer redeboer mentioned this issue Feb 6, 2022
Merged
@redeboer redeboer mentioned this issue Feb 25, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@redeboer redeboer

Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
1 participant
@redeboer