sphinxcontrib_bibtex_urn¶

Sphinx extension that adds Finnish URN identifier support to sphinxcontrib-bibtex.

Usage¶

Add "sphinxcontrib_bibtex_urn" to the extensions list in your Sphinx conf.py after "sphinxcontrib.bibtex":

extensions = [
    "sphinxcontrib.bibtex",
    "sphinxcontrib_bibtex_urn",
]

The extension automatically wraps whatever bibtex_default_style you have configured so that any BibTeX entry containing a urn field will render the identifier as a hyperlink to https://urn.fi/<URN>.

Alternatively, you can skip the Sphinx extension and use one of the pre-registered pybtex styles directly:

bibtex_default_style = "urn_alpha"  # or urn_plain, urn_unsrt, urn_unsrtalpha

Submodules¶

sphinxcontrib_bibtex_urn.styles

Functions¶

setup(→ dict[str, str | bool])

Package Contents¶

sphinxcontrib_bibtex_urn.setup(app: sphinx.application.Sphinx) → dict[str, str | bool]¶

Args:: app: The Sphinx application object.
Returns:: A metadata dictionary with extension information.