MDAnalysis / UserGuide

User Guide for MDAnalysis
https://userguide.mdanalysis.org
22 stars 32 forks source link

Document adding citations in BibTex format #212

Open ojeda-e opened 2 years ago

ojeda-e commented 2 years ago

Is your feature request related to a problem? Please describe. By introducing references in the BibTex format (See https://github.com/MDAnalysis/mdanalysis/pull/3663), citations in reStructuredText are no longer accepted. It would be useful for current or upcoming contributors to have clear instructions on how to add new references to docs using the BibTex Sphinx extension.

Describe the solution you'd like Add a section describing how to add BibTex references/citations to MDAnalysis docs.

Describe alternatives you've considered (open to discussion)

Additional context Issue opened as suggested by @orbeckst in https://github.com/MDAnalysis/mdanalysis/pull/3663#pullrequestreview-1047256196

jaclark5 commented 1 year ago

To compile the docs, pyyaml > 3.01, should be added to installation of the package.