Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib-bibtex-0.2.1.tar.gz (20.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page