tweaks.footnote_symbols

Tweak which monkeypatches docutils to use the following symbols for footnotes:

  • † – dagger

  • ‡ – double dagger

  • § – section mark

  • ¶ – paragraph mark (pilcrow)

  • # – number sign

  • ♠ – spade suit

  • ♥ – heart suit

  • ♦ – diamond suit

  • ♣ – club suit

With some themes the superscript asterisk becomes very hard to see.

New in version 2.7.0.

Enable sphinx_toolbox.tweaks.footnote_symbols by adding the following to the extensions variable in your conf.py:

extensions = [
    ...
    'sphinx_toolbox.tweaks.footnote_symbols',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .

setup(app)[source]

Setup sphinx_toolbox.tweaks.footnote_symbols.

Parameters

app (Sphinx) – The Sphinx application.

Return type

SphinxExtMetadata