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

Hyperlinks to methods without a docstring do not work. #3597

Open
JasonGrace2282 opened this issue Jan 28, 2024 · 2 comments
Open

Hyperlinks to methods without a docstring do not work. #3597

JasonGrace2282 opened this issue Jan 28, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JasonGrace2282
Copy link
Member

Example:
https://docs.manim.community/en/stable/examples.html#braceannotation
Looking at those specific methods it seems to be due to the fact that they do not have a docstring, so sphinx doesn't generate a place that it can hyperlink to.

@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Jan 28, 2024
@biinnnggggg
Copy link
Contributor

Hello! May I take this?

@JasonGrace2282
Copy link
Member Author

JasonGrace2282 commented Apr 12, 2024

Sure! Since this feels like a sphinx issue, the best approach will most likely be adding a ton of docstrings across the library :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants