New Roles

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

Information about a citation reference.

property citation_ref_id

Unique id of this citation reference.

property docname

Document name.

property keys

Citation keys (including key prefix).

property line

Line number.

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

Bases: sphinx.roles.XRefRole

Class for processing the cite role.

result_nodes(document, env, node, is_ref)

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

class sphinxcontrib.bibtex.foot_roles.FootReferenceInfo(key: str, document: docutils.nodes.document, refname: str)

Tuple containing reference info to enable sphinx to resolve a footnote reference.

property document

Current docutils document.

property key

Citation key.

property refname

Citation reference name.

class sphinxcontrib.bibtex.foot_roles.FootReferenceText(info: sphinxcontrib.bibtex.richtext.ReferenceInfo, *parts: pybtex.richtext.BaseText)

Pybtex rich text class for footnote references with the docutils backend, for use with FootReferenceInfo.

render(backend: BaseBackend)

Render this Text into markup.

Parameters

backend – The formatting backend (an instance of pybtex.backends.BaseBackend).

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

Bases: sphinx.roles.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]]

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