Bib Files

Classes and methods to work with bib files.

class sphinxcontrib.bibtex.bibfile.BibFile(mtime: float, data: pybtex.database.BibliographyData)[source]

Contains information about a parsed bib file.

property data

parsed data from pybtex

property mtime

modification time of bib file when last parsed

sphinxcontrib.bibtex.bibfile.normpath_filename(env: sphinx.environment.BuildEnvironment, filename: str)str[source]

Return normalised path to filename for the given environment env.

sphinxcontrib.bibtex.bibfile.parse_bibfile(bibfilename: str, encoding: str) → pybtex.database.BibliographyData[source]

Parse bibfilename with given encoding, and return parsed data.

sphinxcontrib.bibtex.bibfile.process_bibfile(bibfiles: Dict[str, sphinxcontrib.bibtex.bibfile.BibFile], bibfilename: str, encoding: str)None[source]

Check if bibfiles is still up to date. If not, parse bibfilename and store parsed data in bibfiles.

sphinxcontrib.bibtex.bibfile.get_bibliography_entry(bibfiles: Dict[str, sphinxcontrib.bibtex.bibfile.BibFile], key: str) → Optional[pybtex.database.Entry][source]

Return bibliography entry from bibfiles for the given key.