Bib Files¶
Classes and methods to work with bib files.
-
class
sphinxcontrib.bibtex.bibfile.
BibFile
(mtime: float, keys: Dict[str, None])[source]¶ Contains information about a parsed bib file.
-
class
sphinxcontrib.bibtex.bibfile.
BibData
(encoding: str, bibfiles: Dict[str, sphinxcontrib.bibtex.bibfile.BibFile], data: pybtex.database.BibliographyData)[source]¶ 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.
-
-
sphinxcontrib.bibtex.bibfile.
normpath_filename
(env: BuildEnvironment, filename: str) → str[source]¶ Return normalised path to filename for the given environment env.
-
sphinxcontrib.bibtex.bibfile.
parse_bibdata
(bibfilenames: List[str], encoding: str) → sphinxcontrib.bibtex.bibfile.BibData[source]¶ 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[source]¶
-
sphinxcontrib.bibtex.bibfile.
process_bibdata
(bibdata: sphinxcontrib.bibtex.bibfile.BibData, bibfilenames: List[str], encoding: str) → sphinxcontrib.bibtex.bibfile.BibData[source]¶ Parse bibfilenames and store parsed data in bibdata.