Sphinx Interface¶
-
sphinxcontrib.bibtex.
setup
(app)[source]¶ Set up the bibtex extension:
register config values
register directives
register nodes
register roles
register transforms
connect events to functions
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.
-
sphinxcontrib.bibtex.
init_bibtex_cache
(app)[source]¶ Create
app.env.bibtex_cache
if it does not exist yet.- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.
-
sphinxcontrib.bibtex.
purge_bibtex_cache
(app, env, docname)[source]¶ Remove all information related to docname from the cache.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.env (
sphinx.environment.BuildEnvironment
) – The sphinx build environment.
-
sphinxcontrib.bibtex.
merge_bibtex_cache
(app, env, docnames, other)[source]¶ Merge environment information related to docnames.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.env (
sphinx.environment.BuildEnvironment
) – The sphinx build environment.docnames (
str
) – The document names.other (
sphinx.environment.BuildEnvironment
) – The other environment.
-
sphinxcontrib.bibtex.
init_foot_current_id
(app, docname, source)[source]¶ Initialize current footbibliography id for docname.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.docname (
str
) – The document name.source (
str
) – The document source.
-
sphinxcontrib.bibtex.
process_citations
(app, doctree, docname)[source]¶ Replace labels of citation nodes by actual labels.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.doctree (
docutils.nodes.document
) – The document tree.docname (
str
) – The document name.
-
sphinxcontrib.bibtex.
process_citation_references
(app, doctree, docname)[source]¶ Replace text of citation reference nodes by actual labels.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.doctree (
docutils.nodes.document
) – The document tree.docname (
str
) – The document name.
-
sphinxcontrib.bibtex.
check_duplicate_labels
(app, env)[source]¶ Check and warn about duplicate citation labels.
- Parameters
app (
sphinx.application.Sphinx
) – The sphinx application.env (
sphinx.environment.BuildEnvironment
) – The sphinx build environment.