sphinxcontrib-bibtex

0.2.8 BSD License    
  UNRATED

  399 downloads

Sphinx extension for bibtex style references.

description

download

specs

sphinxcontrib-bibtex is a Sphinx extension that 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.

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}
}
read more   
Last updated on August 28th, 2012

#Sphinx extension #bibtex style references #Sphinx #bibtex #style #references

0 User reviews so far.

SUBMIT