Sphinx extension for bibtex style references.
Project description
The sphinxcontrib-bibtex extension allows bibtex references to be inserted into your documentation. The extension adds a bibliography directive, and a cite role, which work similarly to LaTeX’s \bibliography and \cite commands.
- author:
Matthias C. M. Troffaes <matthias.troffaes@gmail.com>
- license:
BSD, see LICENSE.rst for details
Inspired by bibstuff.sphinxext.bibref by Matthew Brett.
Installation
Install the module with pip install sphinxcontrib-bibtex, or from source using python setup.py install. Then add:
extensions = ['sphinxcontrib.bibtex']
to your project’s Sphinx configuration file conf.py.
Minimal Example
In your project’s documentation, you can then write for instance:
See :cite:`1987:nelson` for an introduction to non-standard analysis. .. bibliography:: refs.bib
where refs.bib would contain an entry:
@Book{1987:nelson, author = {Edward Nelson}, title = {Radically Elementary Probability Theory}, publisher = {Princeton University Press}, year = {1977}, series = {Annals of Mathematical Studies} }
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-bibtex-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca4d7d1778906d43f73fc586b5eee7d1520b2320f3c83c2ea50e6b61b3554198 |
|
MD5 | 53778d8b5f865c9451fbe2a907904c8b |
|
BLAKE2b-256 | f26ba4ea93b8eff7bff8200b9df9b12bdf99d49cf92243ad0052294f418c6460 |