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

docs: Add mkdocs-bibtex #5229

Open
cwhite911 opened this issue Feb 27, 2025 · 1 comment
Open

docs: Add mkdocs-bibtex #5229

cwhite911 opened this issue Feb 27, 2025 · 1 comment
Milestone

Comments

@cwhite911
Copy link
Contributor

We have the option to add the mkdocs-bibtex plugin to manage citations through out the documentation.

It would allow us to have a root bib file so that we can reference papers inline using the following format shown in an example from r.sim.water.

[@mitas_distributed_1998-1] Add's a footnote

"The numerical solution is based on the concept of duality between the field and particle representation of the modeled quantity. Green's function Monte Carlo method, used to solve the equation, provides robustness necessary for spatially variable conditions and high resolutions [@mitas_distributed_1998-1]."

Image

This adds an auto generated citation at the end of the page

Image

@wenzeslaus
Copy link
Member

As I said earlier, this is out of scope for the switch to the new documentation. It does not bring any immediate advantage when only enabled, and applying to the existing pages is a large amount of work with limited benefits to the users of the tool. I'm also reluctant to enable every interesting plugin of mkdocs. More plugins, more dependencies. This one also seems like it would make things more complex with all the bibtex stuff, so we will have to be really sure before we purse this. I'm not voting no now and forever, and I see a value in managed, machine readable references, but we should not do this now.

@wenzeslaus wenzeslaus added this to the Future milestone Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants