New Docutils Directives¶
-
class
sphinxcontrib.bibtex.directives.
BibliographyKey
(docname: str, id_: str)[source]¶ Unique key for each bibliography directive.
-
property
docname
¶ Name of the document where the bibliography resides.
-
property
id_
¶ The id of the bibliography node in the document.
-
property
-
class
sphinxcontrib.bibtex.directives.
BibliographyValue
(line: int, bibfiles: List[str], style: str, list_: str, enumtype: str, start: int, labelprefix: str, keyprefix: str, filter_: _ast.AST, citation_nodes: Dict[str, docutils.nodes.citation])[source]¶ Contains information about a bibliography directive.
-
property
bibfiles
¶ List of bib files for this directive.
-
property
citation_nodes
¶ key -> citation node
-
property
enumtype
¶ The sequence type (for enumerated lists).
-
property
filter_
¶ Parsed filter expression.
-
property
keyprefix
¶ String prefix for citation keys.
-
property
labelprefix
¶ String prefix for pybtex generated labels.
-
property
line
¶ Line number of the directive in the document.
-
property
list_
¶ The list type.
-
property
start
¶ The start of the sequence (for enumerated lists).
-
property
style
¶ The pybtex style.
-
property
-
class
sphinxcontrib.bibtex.directives.
BibliographyDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Class for processing the
bibliography
directive.Produces a
bibliography
node, along with (empty) citation nodes that will be formatted later in the env-updated stage, and inserted into the document in a post-transform. We cannot insert the citation nodes here because we do not yet know which keys have been cited.See also
Further processing of the resulting
bibliography
node is done byBibliographyTransform
.
-
class
sphinxcontrib.bibtex.foot_directives.
FootBibliographyDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Class for processing the
footbibliography
directive.-
run
()[source]¶ Set file dependencies, and insert the footnotes that were created earlier by
foot_roles.FootCiteRole.result_nodes()
.
-