Cached Information

Classes and methods to maintain any information that is stored outside the doctree.

class sphinxcontrib.bibtex.cache.Cache[source]

Global bibtex extension information cache. Stored in app.env.bibtex_cache, so must be picklable.

add_cited(key, docname)[source]

Add the given key to the set of cited keys for docname.

Parameters:
  • key (str) – The citation key.
  • docname (str) – The document name.
bibfiles = None

A dict mapping .bib file names (relative to the top source folder) to BibfileCache instances.

get_all_bibliography_caches()[source]

Return all bibliography caches.

get_all_cited_keys()[source]

Yield all citation keys, sorted first by document (alphabetical), then by citation order in the document.

get_bibliography_cache(docname, id_)[source]

Return BibliographyCache with id id_ in document docname.

get_bibliography_entries(docname, id_, warn)[source]

Return filtered bibliography entries, sorted by citation order.

get_cited_docnames(key)[source]

Return the docnames from which the given key is cited.

Parameters:key (str) – The citation key.
get_enum_count(docname)[source]

Get enumeration list counter for document docname.

get_label_from_key(key)[source]

Return label for the given key.

inc_enum_count(docname)[source]

Increment enumeration list counter for document docname.

purge(docname)[source]

Remove all information related to docname.

Parameters:docname (str) – The document name.
set_bibliography_cache(docname, id_, bibcache)[source]

Register bibcache (BibliographyCache) with id id_ for document docname.

set_enum_count(docname, value)[source]

Set enumeration list counter for document docname to value.

class sphinxcontrib.bibtex.cache.BibfileCache[source]

Contains information about a parsed .bib file.

mtime

A float representing the modification time of the .bib file when it was last parsed.

data

A pybtex.database.BibliographyData containing the parsed .bib file.

class sphinxcontrib.bibtex.cache.BibliographyCache[source]

Contains information about a bibliography directive.

bibfiles

A list of strs containing the .bib file names (relative to the top source folder) that contain the references.

style

The bibtex style.

list_

The list type.

enumtype

The sequence type (only used for enumerated lists).

start

The first ordinal of the sequence (only used for enumerated lists).

labels

Maps citation keys to their final labels.

labelprefix

This bibliography’s string prefix for pybtex generated labels.

keyprefix

This bibliography’s string prefix for citation keys.

filter_

An ast.AST node, containing the parsed filter expression.