New Roles

class sphinxcontrib.bibtex.roles.CitationRef(citation_ref_id: str, docname: str, line: int, targets: List[CitationTarget])[source]

Information about a citation reference.

property citation_ref_id

Unique id of this citation reference.

property docname

Document name.

property line

Line number.

property targets

Citation targets (key, pre, post).

class sphinxcontrib.bibtex.roles.CiteRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Optional[Type[Element]] = None, innernodeclass: Optional[Type[TextElement]] = None, warn_dangling: bool = False)[source]

Bases: XRefRole

Class for processing the cite role.

result_nodes(document, env, node, is_ref)[source]

Associate the pending_xref with the cite domain, and note the cited citation keys.

class sphinxcontrib.bibtex.foot_roles.FootCiteRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Optional[Type[Element]] = None, innernodeclass: Optional[Type[TextElement]] = None, warn_dangling: bool = False)[source]

Bases: XRefRole

Class for processing the footcite role.

result_nodes(document: docutils.nodes.document, env: BuildEnvironment, node: docutils.nodes.Element, is_ref: bool) Tuple[List[docutils.nodes.Node], List[docutils.nodes.system_message]][source]

Transform node into footnote references, and add footnotes to a node stored in the environment’s temporary data if they are not yet present.

See also

The node containing all footnotes is inserted into the document by foot_directives.FootBibliographyDirective.run().