MDAnalysis / mdaencore

Ensemble overlap comparison software for molecular data.
http://www.mdanalysis.org/mdaencore/
GNU General Public License v2.0
0 stars 0 forks source link

bibtex bibliography should be footbibliography #12

Closed lilyminium closed 1 year ago

lilyminium commented 1 year ago

Expected behavior

If you want a local bibliography in similarity.py, the correct directives to use are actually footbibliography and footcite. cite and bibliography are to be used for global bibliographies, like a separate references page.

Making this change allowed me to build docs as below:

Screenshot 2023-08-24 at 9 48 48 am
lilyminium commented 1 year ago

It is still weird that it goes:

  1. Function reference heading
  2. Bibliography
  3. Actual function reference

But I presume that has something to do with the layout of the module docstring:

Function reference
==================

.. All functions are included via automodule :members:.

.. rubric:: References

.. footbibliography::

@ianmkenney you may need to manually .. autosummary there if you want it in a more logical order.

Tbh a global bibliography might make more sense.