New Directives

class sphinxcontrib.bibtex.directives.BibliographyKey(docname, id_)[source]
docname: str

Alias for field number 0

id_: str

Alias for field number 1

class sphinxcontrib.bibtex.directives.BibliographyValue(line: int, bibfiles: List[str], style: str, list_: str, enumtype: str, start: int, labelprefix: str, keyprefix: str, filter_: ast.AST, citation_nodes: Dict[str, docutils.nodes.citation])[source]

Contains information about a bibliography directive.

bibfiles: List[str]

List of bib files for this directive.

citation_nodes: Dict[str, docutils.nodes.citation]

key -> citation node

enumtype: str

The sequence type (for enumerated lists).

filter_: ast.AST

Parsed filter expression.

keyprefix: str

String prefix for citation keys.

labelprefix: str

String prefix for pybtex generated labels.

line: int

Line number of the directive in the document.

list_: str

The list type.

start: int

The start of the sequence (for enumerated lists).

style: str

The pybtex style.

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 node that is to be transformed to the entries of the bibliography.

class sphinxcontrib.bibtex.foot_directives.FootBibliographyDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Class for processing the footbibliography directive.

run()[source]

Set file dependencies, and insert the footnotes that were created earlier by foot_roles.FootCiteRole.result_nodes().