-
Notifications
You must be signed in to change notification settings - Fork 7
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
Citations from docstrings are not collected #39
Comments
Just ran into this as well. I guess we don't traverse docstrings during the collection phase. |
Haven’t had a chance yet to confirm, but I’ll make sure to fix this asap, later this week |
And here... this used to work, now failing with Documenter.jl v1.0 and DocumenterCitations v1.2 Example of failure: https://github.com/PALEOtoolkit/PALEOcopse.jl/actions/runs/6207321855/job/16852451709 |
Indeed, this was a regression in version 1.2, where we don't recurse into docstring nodes during the collection step. Thus, any reference that was only cited in a docstring would be missed. Should be fixed with #40 |
Many thanks!! |
I found no way to include a citation in a docstring of a method.
Maybe there is one...
Citation is read from the references.bib, but not found later.
The following error show up:
A workaround is to place the citation in a .md of your documentation pages.
[dummycitation](@cite)
Then the citation is rendered even inside doscstrings.
Using DocumenterCitations v1.2.0 with Julia 1,9.1.
The text was updated successfully, but these errors were encountered: