Pybtex Extensions¶
New Text Elements¶
- class sphinxcontrib.bibtex.richtext.BaseReferenceText(info: sphinxcontrib.bibtex.richtext.ReferenceInfo, *parts: pybtex.richtext.BaseText)[source]¶
Generic rich text element for citation references. Instances store some extra reference info that can be used when formatting. This base class renders its children without further formatting. Implementations must create a derivation from this class which overrides the render method to create the desired output. See for instance
SphinxReferenceText
.
- sphinxcontrib.bibtex.richtext.ReferenceInfo¶
Generic type parameter for types that store reference information. To be implemented by clients. See for instance
SphinxReferenceInfo
.alias of TypeVar(‘ReferenceInfo’)
New Template Nodes¶
- sphinxcontrib.bibtex.style.template.join(sep='', sep2=None, last_sep=None, other=None)[source]¶
Join text fragments together.
- sphinxcontrib.bibtex.style.template.sentence(capfirst=False, capitalize=False, add_period=True, sep=', ', sep2=None, last_sep=None, other=None)[source]¶
Join text fragments, capitalize the first letter, and add a period to the end.
- sphinxcontrib.bibtex.style.template.names(role, sep='', sep2=None, last_sep=None, other=None)[source]¶
Return formatted names.
- sphinxcontrib.bibtex.style.template.entry_label()¶
Node for inserting the label of a formatted entry.
- sphinxcontrib.bibtex.style.template.reference()¶
Node for inserting a citation reference. The children of the node comprise the content of the reference, and any referencing information is stored in the reference_info key of the data. The data must also contain a style key pointing to the corresponding
BaseReferenceStyle
.