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 bibliography directive.

Parses the bibliography files, and produces a bibliography node.

See also

Further processing of the resulting bibliography node is done by BibliographyTransform.

run()[source]

Process .bib files, set file dependencies, and create a nodes for all 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 (see update_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

parse_bibfile(bibfile, encoding)[source]

Parse bibfile, and return parsed data.

Parameters:bibfile (str) – The bib file name.
Returns:The parsed bibliography data.
Return type:pybtex.database.BibliographyData

Project Versions

Previous topic

New Doctree Nodes

Next topic

New Doctree Transforms

This Page