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

Document how to work with sphinxcontrib-bibtex #26

Closed
lilyminium opened this issue Aug 23, 2023 · 1 comment · Fixed by #53
Closed

Document how to work with sphinxcontrib-bibtex #26

lilyminium opened this issue Aug 23, 2023 · 1 comment · Fixed by #53

Comments

@lilyminium
Copy link
Member

lilyminium commented Aug 23, 2023

I think appropriate guidelines would be:

  • for an internal module where you think a table may get rendered through autosummary, use footbibliography, the directive for local bibs
  • for an overall references page for the entire module: use bibliography. The issue in Incompatible with sphinxcontrib-bibtex? #25 was that a table got incorrectly rendered after the correctly rendered bibliography, so as long as we take care not to use global references in a module, I think we will avoid it in the future.
    For reference, the user guide has a global bibliography: https://userguide.mdanalysis.org/stable/references.html

Also we should pin to bibtex>2.0 where the footbib was first introduced

@ianmkenney
Copy link
Collaborator

@lilyminium, see MDAnalysis/mdaencore#17, most likely relevant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants