New Doctree Directives¶
-
class
sphinxcontrib.bibtex.directives.BibliographyDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Class for processing the
bibliographydirective.Parses the bibliography files, and produces a
bibliographynode.See also
Further processing of the resulting
bibliographynode is done byBibliographyTransform.-
run()[source]¶ Process .bib files, set file dependencies, and create a node that is to be transformed to the entries of the bibliography.
-
process_bibfile(bibfile, encoding)[source]¶ Check if
env.bibtex_cache.bibfiles[bibfile]is still up to date. If not, parse the bibfile (seeupdate_bibfile_cache()), and store parsed data in the bibtex cache.Parameters: bibfile ( str) – The bib file name.Returns: The parsed bibliography data. Return type: pybtex.database.BibliographyData
-
update_bibfile_cache(bibfile, mtime, encoding)[source]¶ Parse bibfile (see
parse_bibfile()), and store the parsed data, along with modification time mtime, in the bibtex cache.Parameters: - bibfile (
str) – The bib file name. - mtime (
float) – The bib file’s modification time.
Returns: The parsed bibliography data.
Return type: pybtex.database.BibliographyData- bibfile (
-
-
sphinxcontrib.bibtex.directives.process_start_option(value)[source]¶ Process and validate the start option value of a
bibliographydirective. If value iscontinuethen this function returns -1, otherwise value is converted into a positive integer.