Skip to content

Commit

Permalink
add specification with example for entries in bib-file to documentati…
Browse files Browse the repository at this point in the history
  • Loading branch information
Moritz-Alexander-Kern committed Jul 25, 2022
1 parent 4cbbd08 commit 131d093
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion doc/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,31 @@ Citations
The citations are in BibTeX format, stored in `doc/bib/elephant.bib
<https://github.com/NeuralEnsemble/elephant/blob/master/doc/bib/elephant.bib>`_.

To cite Elephant, refer to :doc:`citation`.
Entries in the .bib are built according to the following specification:

``{Last name of first author}+{last two digits of publication year}+"_"+{first page of article}``


.. admonition:: Example

According to this specification, the following article:

S. Grün. Data-driven significance estimation of precise spike correlation. J. Neurophysiol., pages 1126–1140, 2009. doi:10.1152/jn.00093.2008.

is added to the .bib-file as ``Gruen09_1126``. The complete entry for this example is:

.. code-block:: rst
@article{Gruen09_1126,
title={Data-driven significance estimation of precise spike correlation},
author={Gr\"{u}n, S.},
year={2009},
journal={J. Neurophysiol.},
number={101},
pages={1126--1140},
doi={10.1152/jn.00093.2008}
}
Each module in ``doc/reference`` folder ends with the reference section:

Expand All @@ -328,4 +352,6 @@ For example, ``:cite:'spade-Torre2013_132'`` will be rendered as ``sp1`` in
the built HTML documentation, if ``<module name shortcut>`` is set to ``sp``
and ``<module name>`` - to ``spade``.

To cite Elephant itself, refer to :doc:`citation`.

.. _Issue tracker: https://github.com/NeuralEnsemble/elephant/issues

0 comments on commit 131d093

Please sign in to comment.