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:
- bibfiles = None¶
A dict mapping .bib file names (relative to the top source folder) to BibfileCache instances.
- 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.
- 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.
- class sphinxcontrib.bibtex.cache.BibfileCache[source]¶
Contains information about a parsed .bib file.
- 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.