New Roles¶
-
class
sphinxcontrib.bibtex.roles.
CiteRole
(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)[source]¶ Bases:
sphinx.roles.XRefRole
Class for processing the
cite
role.
-
class
sphinxcontrib.bibtex.foot_roles.
FootCiteRole
(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)[source]¶ Bases:
sphinx.roles.XRefRole
Class for processing the
footcite
role.-
result_nodes
(document: docutils.nodes.document, env: sphinx.environment.BuildEnvironment, node: docutils.nodes.Element, is_ref: bool) → Tuple[List[docutils.nodes.Node], List[docutils.nodes.system_message]][source]¶ Transform reference node into a footnote reference, and note that the reference was cited.
-