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

References are rendering weirdly #212

Open
billbrod opened this issue Aug 14, 2024 · 0 comments
Open

References are rendering weirdly #212

billbrod opened this issue Aug 14, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@billbrod
Copy link
Member

While numpydoc supports a dedicated references section, mkdocstrings does not. The advice is to use footnotes to get something similar, but we've struggled to get them working correctly. In particular, the footnote itself renders correctly, but not the link to it (and thus, not the link back). Should poke around and see if there's something wrong with our configuration that's messing this up. An alternative would be annotations, but I think that isn't a perfect replacement (in particular, it doesn't work well when you have multiples citations to the same reference)

@billbrod billbrod added bug Something isn't working documentation Improvements or additions to documentation labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant