sphinxcontrib-bibtex

What it is and what it does

sphinxcontrib-bibtex is a Sphinx extension that integrates BibTeX citation management into documentation builds. It provides two citation roles—`:cite:t:` for textual citations and `:cite:p:` for parenthetical ones—and a `bibliography` directive to render the full reference list. Under the hood, it uses pybtex to parse and format BibTeX entries, making it possible to write academic and technical documentation with proper citation support.

The extension supports both global bibliographies (a single bibliography across the entire project) and local per-document bibliographies using footnote-style citations with the `footcite` role and `footbibliography` directive. It has been in active development since 2012, is marked Production/Stable, and currently supports Python 3.10 through 3.14.

Use it for:

• Academic papers and technical reports where you need to cite research with standard BibTeX entries.
• API documentation that references external papers, standards, or related work in a structured bibliography.
• Multi-document projects where different chapters or sections maintain separate local bibliographies via footnote citations.
• Converting LaTeX documentation to Sphinx while preserving BibTeX citations without manual rewriting.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that enables BibTeX-style citations in documentation, supporting textual and parenthetical citation roles with automatic bibliography generation.

Yes. The extension is production-stable, actively maintained, has no known vulnerabilities, and solves a specific problem well—adding BibTeX citations to Sphinx docs. Install friction is low and it integrates cleanly into existing Sphinx projects. Worth installing if you need structured citation management in documentation.

Install

sphinxcontrib-bibtex on PyPI

pip install sphinxcontrib-bibtex

uv add sphinxcontrib-bibtex

poetry add sphinxcontrib-bibtex

Installing sphinxcontrib-bibtex

Before you install

Low friction installation with a pure-Python wheel. Actively maintained as of May 2026 with recent commits; supports modern Python versions from 3.10 onward.

License in practice

BSD-2-Clause is permissive; you can use this in commercial and proprietary projects with minimal restrictions.

Quickstart

pip install sphinxcontrib-bibtex

In conf.py:
extensions = ['sphinxcontrib.bibtex']
bibtex_bibfiles = ['refs.bib']

In your .rst file:
See :cite:t:`key` for details.

.. bibliography::

Requires Python 3.10 or later; Sphinx and pybtex must be installed as runtime dependencies.

Verify before relying

• Whether the extension handles complex BibTeX entry types and custom formatting styles beyond the default.
• Performance characteristics when managing bibliographies with hundreds or thousands of citations.
• Compatibility with Sphinx themes and HTML/PDF output formats.

Package facts

Evidence: sphinxcontrib_bibtex-2.7.0-py3-none-any.whl

Tags

More Utilities packages