search

sfstoolbox / sfs-python

SFS Toolbox for Python
https://sfs-python.readthedocs.io
MIT License
65 stars 19 forks source link

DOC: add compatibility for sphinxcontrib-bibtex>=2 #169

Closed hagenw closed 3 years ago

hagenw commented 3 years ago

the test in https://github.com/sfstoolbox/sfs-python/pull/168 are failing as sphinxcontrib-bibtex introduced a breaing change with version 2.0.0 as you have to add another config setting.

This fixes thie issue.

mgeier commented 3 years ago

I think now the references.bib argument can be removed from references.rst:

.. bibliography:: references.bib
    :style: alpha
    :all:

Also, I think :all: isn't necessary anymore, right?

I'm not sure though, because I cannot check it locally because I'm getting some errors (which may be related to my broken installation).

hagenw commented 3 years ago

Thanks, references.bib is indeed no longer needed. :all: includes all references, also not cited once. I removed that option as well. I was able to execute the code locally and found also one wrong citation to Ahrens2012 that was not using the bibtex plugin, and corrected that as well.