pybtex-docutils

What it is and what it does

pybtex-docutils is a docutils backend that allows BibTeX bibliography files to be processed and rendered as citations within reStructuredText documents. It exposes a simplebibliography directive that generates formatted citations for every entry in a specified .bib file, placing them at the document location you choose. The package is designed for straightforward single-document workflows that do not require Sphinx; for Sphinx projects, the documentation recommends using sphinxcontrib-bibtex instead.

The package depends on docutils and pybtex, and requires you to write a custom command script to register the directive with docutils. Citation keys from your .bib file become the labels in your document, with the constraint that keys cannot contain colons to remain valid docutils citation labels.

Use it for:

• Generate bibliographies in standalone reStructuredText documents without Sphinx infrastructure
• Render BibTeX citations in simple documentation projects that use docutils directly
• Convert academic papers or technical reports written in reStructuredText with BibTeX references to HTML
• Add citation support to custom docutils-based documentation pipelines

Worth the install?

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

Integrates BibTeX citations into docutils-generated documentation, enabling bibliography rendering in reStructuredText documents without Sphinx.

Yes, if you need BibTeX citations in pure docutils workflows. Install friction is low and the license is permissive. However, maintenance is aging (last release 1088 days ago); verify compatibility with your docutils version before relying on it in production.

Install

pybtex-docutils on PyPI

pip install pybtex-docutils

uv add pybtex-docutils

poetry add pybtex-docutils

Installing pybtex-docutils

Before you install

Low install friction with two straightforward dependencies. Maintenance is aging—last release was 1088 days ago, though the repository remains active with a recent commit and not archived.

License in practice

MIT license permits unrestricted use, modification, and distribution with minimal legal constraints.

Quickstart

pip install pybtex-docutils

from docutils.parsers.rst import directives
from docutils.core import publish_cmdline
from pybtex_docutils import SimpleBibliography

directives.register_directive("simplebibliography", SimpleBibliography)
publish_cmdline(writer_name='html5')

You must write a custom command script to register the directive; docutils does not provide a built-in extension mechanism.

Verify before relying

• Whether the package works reliably with docutils versions released after August 2023
• Performance characteristics with large bibliography files or complex citation schemes

Package facts

Evidence: pybtex_docutils-1.0.3-py3-none-any.whl

Tags

More XML packages