Bib Files

Classes and methods to work with bib files.

class sphinxcontrib.bibtex.bibfile.BibFile(mtime: float, keys: Dict[str, None])

Contains information about a parsed bib file.

keys: Dict[str, None]

Set of keys for this bib file as ordered dict.

mtime: float

Modification time of file when last parsed.

class sphinxcontrib.bibtex.bibfile.BibData(encoding: str, bibfiles: Dict[str, sphinxcontrib.bibtex.bibfile.BibFile], data: pybtex.database.BibliographyData)

Contains information about a collection of bib files.

bibfiles: Dict[str, sphinxcontrib.bibtex.bibfile.BibFile]

Maps bib filename to information about it.

data: pybtex.database.BibliographyData

Data parsed from all bib files.

encoding: str

Encoding of all bib files.

sphinxcontrib.bibtex.bibfile.normpath_filename(env: BuildEnvironment, filename: str) → str

Return normalised path to filename for the given environment env.

sphinxcontrib.bibtex.bibfile.parse_bibdata(bibfilenames: List[str], encoding: str) → sphinxcontrib.bibtex.bibfile.BibData

Parse bibfilenames with given encoding, and return parsed data.

sphinxcontrib.bibtex.bibfile.is_bibdata_outdated(bibdata: sphinxcontrib.bibtex.bibfile.BibData, bibfilenames: List[str], encoding: str) → bool

sphinxcontrib.bibtex.bibfile.process_bibdata(bibdata: sphinxcontrib.bibtex.bibfile.BibData, bibfilenames: List[str], encoding: str) → sphinxcontrib.bibtex.bibfile.BibData

Parse bibfilenames and store parsed data in bibdata.