New Domains¶
Classes and methods to maintain any bibtex information that is stored outside the doctree.
-
class
sphinxcontrib.bibtex.domain.Citation(citation_id: str, bibliography_key: BibliographyKey, key: str, label: str, formatted_entry: FormattedEntry)[source]¶ Information about a citation.
-
property
bibliography_key¶ Key of its bibliography directive.
-
property
citation_id¶ Unique id of this citation.
-
property
formatted_entry¶ Entry as formatted by pybtex.
-
property
key¶ Key (with prefix).
-
property
label¶ Label (with prefix).
-
property
-
class
sphinxcontrib.bibtex.domain.BibtexDomain(env: BuildEnvironment)[source]¶ Sphinx domain for the bibtex extension.
-
property
bibfiles¶ Map each bib filename to some information about the file (including the parsed data).
-
property
bibliographies¶ Map storing information about each bibliography directive.
-
property
citation_refs¶ Citation reference data.
-
property
citations¶ Citation data.
-
clear_doc(docname: str) → None[source]¶ Remove traces of a document in the domain-specific inventories.
-
get_all_cited_keys(docnames)[source]¶ Yield all citation keys for given docnames in order, then ordered by citation order.
-
get_entries(bibfiles: List[str]) → Iterable[Entry][source]¶ Return all bibliography entries from the bib files, unsorted (i.e. in order of appearance in the bib files.
-
get_filtered_entries(bibliography_key: BibliographyKey) → Iterable[Tuple[str, Entry]][source]¶ Return unsorted bibliography entries filtered by the filter expression.
-
get_formatted_entries(bibliography_key: BibliographyKey, docnames: List[str]) → Iterable[FormattedEntry][source]¶ Get sorted bibliography entries along with their pybtex labels, with additional sorting and formatting applied from the pybtex style.
-
get_sorted_entries(bibliography_key: BibliographyKey, docnames: List[str]) → Iterable[Tuple[str, Entry]][source]¶ Return filtered bibliography entries sorted by citation order.
-
property