New Directives

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

Alias for field number 0

property id_

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.

property bibfiles

List of bib files for this directive.

property citation_nodes

key -> citation node

property enumtype

The sequence type (for enumerated lists).

property filter_

Parsed filter expression.

property keyprefix

String prefix for citation keys.

property labelprefix

String prefix for pybtex generated labels.

property line

Line number of the directive in the document.

property list_

The list type.

property start

The start of the sequence (for enumerated lists).

property style

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().