New Roles¶
-
class
sphinxcontrib.bibtex.roles.
CitationRef
(citation_ref_id: str, docname: str, line: int, keys: List[str])[source]¶ Information about a citation reference.
-
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.
FootReferenceInfo
(key: str, document: docutils.nodes.document, refname: str)[source]¶ Tuple containing reference info to enable sphinx to resolve a footnote reference.
-
document
: docutils.nodes.document¶ Current docutils document.
-
-
class
sphinxcontrib.bibtex.foot_roles.
FootReferenceText
(info: ReferenceInfo, *parts: pybtex.richtext.BaseText)[source]¶ Pybtex rich text class for footnote references with the docutils backend, for use with
FootReferenceInfo
.
-
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: 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()
.
-