1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
#!/usr/bin/env python3
#
# footnote_symbols.py
r"""
Tweak which monkeypatches docutils to use the following symbols for footnotes:
.. rst-class:: bullet-hidden
* † -- 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.
.. versionadded:: 2.7.0
.. extensions:: sphinx_toolbox.tweaks.footnote_symbols
-----
""" # noqa: D400
#
# Copyright © 2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from typing import List
# 3rd party
from docutils.transforms.references import Footnotes
from sphinx.application import Sphinx
# this package
from sphinx_toolbox.utils import SphinxExtMetadata, metadata_add_version
__all__ = ("setup", )
#: The list of symbols
symbols: List[str] = [
# Entries 1-3 and 5 below are from section 12.51 of
# The Chicago Manual of Style, 14th edition.
'†', # dagger †
'‡', # double dagger ‡
'§', # section mark §
'¶', # paragraph mark (pilcrow) ¶
# (parallels ['||'] in CMoS)
'#', # number sign
# The entries below were chosen arbitrarily.
'♠', # spade suit ♠
'♥', # heart suit ♥
'♦', # diamond suit ♦
'♣', # club suit ♣
]
@metadata_add_version
def setup(app: Sphinx) -> SphinxExtMetadata:
"""
Setup :mod:`sphinx_toolbox.tweaks.footnote_symbols`.
:param app: The Sphinx application.
"""
Footnotes.symbols = symbols
return {"parallel_read_safe": True}
|
