search

scverse / squidpy_notebooks

Tutorials for Squidpy
https://squidpy.readthedocs.io/en/stable/
MIT License
30 stars 17 forks source link

References in squidpy_notebooks #34

Closed hspitzer closed 3 years ago

hspitzer commented 3 years ago

How can I cite a paper in a tutorial / example? I saw that in squidpy you can use [CIT]_, where CIT is defined in references.rst. Can I do the same in squidpy_notebooks? Will references from squidpy be available here as well?

michalk8 commented 3 years ago

You can do [CIT]_ and add the citation to references.rst in squidpy - this will linked when building the final docs, not the notebooks. I've added references also to squidpy_notebooks to verify that links are fine during notebooks build, but really the references.rst in squidpy matter.

Now that you bring this up, I think it would be better to introduce sphinxcontrib-bibtex so that we only have to worry about a .bib file (and generate RST from it). Will create an issue on the main repo.

hspitzer commented 3 years ago

Great, thanks. I added my references, good to know that ultimately we will only need one references.rst

Re making this process even easier by using a .bib file: if its easy to configure, that would be great, but I would not worry too much about it. We only have a handful of references, so we can live with editing the rst.