Sphinx Interface

sphinxcontrib.bibtex.setup(app)[source]

Set up the bibtex extension:

  • register config values
  • register directives
  • register nodes
  • register roles
  • register transforms
  • connect events to functions
Parameters:app (sphinx.application.Sphinx) – The sphinx application.
sphinxcontrib.bibtex.init_bibtex_cache(app)[source]

Create app.env.bibtex_cache if it does not exist yet.

Parameters:app (sphinx.application.Sphinx) – The sphinx application.
sphinxcontrib.bibtex.purge_bibtex_cache(app, env, docname)[source]

Remove all information related to docname from the cache.

Parameters:
sphinxcontrib.bibtex.process_citations(app, doctree, docname)[source]

Replace labels of citation nodes by actual labels.

Parameters:
  • app (sphinx.application.Sphinx) – The sphinx application.
  • doctree (docutils.nodes.document) – The document tree.
  • docname (str) – The document name.
sphinxcontrib.bibtex.process_citation_references(app, doctree, docname)[source]

Replace text of citation reference nodes by actual labels.

Parameters:
  • app (sphinx.application.Sphinx) – The sphinx application.
  • doctree (docutils.nodes.document) – The document tree.
  • docname (str) – The document name.
sphinxcontrib.bibtex.check_duplicate_labels(app, env)[source]

Check and warn about duplicate citation labels.

Parameters: