How to cite function and page

[aloctavodia]

We could list on a single page not only how to cite ArviZ but also the methods implemented in ArviZ. Additionally, we could have a function that prints the citations maybe in BibTeX format to the screen and/or save them to a file. By default, the function could return just ArviZ's citation, but we could pass an argument to list everything or pass a list of methods to return just the requested citations,

I am writing this in arviz-stats, but this is also about the methods/citations in arviz-base and arviz-plots too.

The function could live inside arviz-base, when ask to return a full list of citations the list should be conditional on which arviz subpackages are installed.

[amaloney]

A dump of all citations to BibTEX would be great. Something like

import arviz as az  # or arviz_base, arviz_stats, arviz_plots
az.citations(save_as="bibtex")

I would also like to highlight Mik's (@krassowski) work to render docstrings in a notebook. In case a user is curious about the provenance of the method they are working with. We could reference this in the documentation so users that are working in a notebook can get exposed to this great extension.

https://github.com/ipython-contrib/ipython-markdown-inspector

Below is an example where I added a doi link to the referenced paper of the method's docstring so you can click and go to the journal's page. I think this would enhance user's experiences using the tools

jupyter-render.webm

It will also correctly render math

[aloctavodia]

That extension is great! Thanks for sharing!

[aloctavodia]

See https://github.com/arviz-devs/arviz-plots/blob/main/References.md

[aloctavodia]

@rohanbabbar04 pinging you, as you worked on a similar function for preliz.

[rohanbabbar04]

Sorry, I missed this message. Yup, maybe a good reference is the PR.

We also used sphinxcontrib-bibtex to manage the references, along with a function (using regex) which made it easy to work with it.