Skip to main content

A docutils backend for pybtex.

Project description

Overview

The pybtex docutils backend allows BibTeX citations to be inserted into documentation generated by docutils.

Installation

For use with Sphinx, simply install sphinxcontrib-bibtex.

For use with pure docutils, install the module with pip install pybtex_docutils, or from source using pip install -e ..

Minimal Example

For use with Sphinx, refer to the sphinxcontrib-bibtex documentation.

For use with pure docutils, the module exposes a new simplebibliography directive, which will generate a citation for every entry in the specified bib files. This new directive is only intended for simple single document workflows that do not require the full power of Sphinx. You need exactly one of these directives in your document, placed at the location where you want the citations to appear (typically, at the end).

For example:

See  [Nelson1987]_ for an introduction to non-standard analysis.

.. simplebibliography:: refs.bib

where refs.bib might contain:

@Book{Nelson1987,
  author = {Edward Nelson},
  title = {Radically Elementary Probability Theory},
  publisher = {Princeton University Press},
  year = {1987}
}

Note that citation keys are used as labels. For this to work, it is thus necessary that all keys in your bib file are valid citation labels for docutils. In particular, they cannot contain colons. This limitation is lifted in sphinxcontrib-bibtex, which also provides many more citation features.

To use the directive, you have to write your own command script (there seems to be no other way currently to extend docutils). For instance:

#!/usr/bin/env python3
from docutils.parsers.rst import directives, Directive
from docutils.core import publish_cmdline, default_description

from pybtex_docutils import SimpleBibliography

description = ('Like rst2html5.py, but with .. simplebibliography support'
               + default_description)

if __name__ == '__main__':
    directives.register_directive("simplebibliography", SimpleBibliography)
    publish_cmdline(writer_name='html5', description=description)

You can then run this command as if you would run rst2html5.

Project details


Download files

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

Source Distribution

pybtex-docutils-1.0.3.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

pybtex_docutils-1.0.3-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file pybtex-docutils-1.0.3.tar.gz.

File metadata

  • Download URL: pybtex-docutils-1.0.3.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pybtex-docutils-1.0.3.tar.gz
Algorithm Hash digest
SHA256 3a7ebdf92b593e00e8c1c538aa9a20bca5d92d84231124715acc964d51d93c6b
MD5 2f729370721e55a4517cad7367ce98f9
BLAKE2b-256 7e84796ea94d26188a853660f81bded39f8de4cfe595130aef0dea1088705a11

See more details on using hashes here.

File details

Details for the file pybtex_docutils-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pybtex_docutils-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8fd290d2ae48e32fcb54d86b0efb8d573198653c7e2447d5bec5847095f430b9
MD5 01cc832ae35e23ef1248f03acff571b5
BLAKE2b-256 11b1ce1f4596211efb5410e178a803f08e59b20bedb66837dcf41e21c54f9ec1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page