Getting Started

Overview

A Sphinx extension for BibTeX style citations.

This extension allows BibTeX citations to be inserted into documentation generated by Sphinx, via a bibliography directive, and a cite role, which work similarly to LaTeX’s thebibliography environment and \cite command.

For formatting, the extension relies on pybtex written by Andrey Golovizin. The extension is inspired by Matthew Brett’s bibstuff.sphinxext.bibref.

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 = {1987}
}

Project Versions

Table Of Contents

Previous topic

Welcome to sphinxcontrib-bibtex’s documentation!

Next topic

Usage

This Page