search

JuliaDynamics / ComplexityMeasures.jl

Estimators for probabilities, entropies, and other complexity measures derived from data in the context of nonlinear dynamics and complex systems
MIT License
49 stars 11 forks source link

Use DocumenterCitations.jl #301

Closed Datseris closed 10 months ago

Datseris commented 11 months ago

This package: https://github.com/ali-ramadhan/DocumenterCitations.jl has been published recently. It simplifies a lot citing papers in the documentation. It allows doing it using a BiBtext format. For us, especially since we are currently writing a paper about ComplexityuMeasyres.jl, we are anyways creating such a bibtext file.

But, given how many papers we cite in our documentation, it will be a long process to port everything,.

For reference, this PR: https://github.com/JuliaDynamics/Attractors.jl/pull/87

ports Attractors.jl to the package, and worked great. I am happy with it overall!

kahaaga commented 11 months ago

Awesome! We should definitely port the citations to DocumenterCitations.jl before sending in the paper. It is actually a selling point - that we are also meticulous about citing the literature in a systematic way.

It is a bit of work, but nothing too major. I can do it --- starting a PR now!

kahaaga commented 11 months ago

Note to self: for remaining packages, finding and replacing the citations with the new style is just a find-place in VSCode with the regex expression \[\^([A-Za-z0-9]+)\], replacing with [$1](@cite). This assumes that all citations are on the format Authors1999.

EDIT: Then, find all occurrences of these citations in both code and docs by searching for regex \[[A-Za-z0-9]+\]\(@cite\):

EDIT 2: This doesn't find reference with special characters, so it needs to be modified if special characters like á are part of some key.