# 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[Path, BibFile], data: BibliographyData)

  Contains information about a collection of bib files.

  bibfiles: Dict[Path, BibFile]

    Maps bib filename to information about it.

  data: BibliographyData

    Data parsed from all bib files.

  encoding: str

    Encoding of all bib files.

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

  Parse bibfilenames with given encoding, and return parsed data.

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

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

  Parse bibfilenames and store parsed data in bibdata.