Skip to content

Commit e0124e6

Browse files
doc: add favicon
Part of #67
1 parent af45d16 commit e0124e6

17 files changed

+199
-2
lines changed
9.77 KB
Loading
10.5 KB
Loading
13.8 KB
Loading
14.8 KB
Loading
3.66 KB
Loading
3.9 KB
Loading
5.02 KB
Loading
5.44 KB
Loading

doc/_static/favicon/generate-png.sh

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
for SIZE in 16 32 96 128 196
2+
do
3+
convert -background none -resize ${SIZE}x${SIZE} icon.svg icon-${SIZE}x${SIZE}.png
4+
done
5+
6+
for SIZE in 57 60 72 76 114 120 144 152
7+
do
8+
convert -background none -resize ${SIZE}x${SIZE} icon.svg apple-touch-icon-${SIZE}x${SIZE}.png
9+
done

doc/_static/favicon/icon-128x128.png

11.7 KB
Loading

doc/_static/favicon/icon-16x16.png

1.01 KB
Loading

doc/_static/favicon/icon-196x196.png

21.4 KB
Loading

doc/_static/favicon/icon-32x32.png

1.86 KB
Loading

doc/_static/favicon/icon-96x96.png

7.57 KB
Loading

doc/_static/favicon/icon.svg

+99
Loading

doc/conf.py

+90-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
# Add any Sphinx extension module names here, as strings. They can be extensions
3131
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3232
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
33-
'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_paramlinks',]
33+
'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_paramlinks',
34+
'sphinx-favicon',]
3435

3536
autodoc_default_options = {
3637
'members': True,
@@ -129,10 +130,97 @@
129130
# pixels large.
130131
#html_favicon = None
131132

133+
# Set up favicons with sphinx-favicon.
134+
favicons = [
135+
{
136+
"rel": "icon",
137+
"static-file": "favicon/icon.svg",
138+
"type": "image/svg",
139+
},
140+
{
141+
"rel": "icon",
142+
"sizes": "16x16",
143+
"static-file": "favicon/icon-16x16.png",
144+
"type": "image/png",
145+
},
146+
{
147+
"rel": "icon",
148+
"sizes": "32x32",
149+
"static-file": "favicon/icon-32x32.png",
150+
"type": "image/png",
151+
},
152+
{
153+
"rel": "icon",
154+
"sizes": "96x96",
155+
"static-file": "favicon/icon-96x96.png",
156+
"type": "image/png",
157+
},
158+
{
159+
"rel": "icon",
160+
"sizes": "128x128",
161+
"static-file": "favicon/icon-128x128.png",
162+
"type": "image/png",
163+
},
164+
{
165+
"rel": "icon",
166+
"sizes": "196x196",
167+
"static-file": "favicon/icon-196x196.png",
168+
"type": "image/png",
169+
},
170+
{
171+
"rel": "apple-touch-icon",
172+
"sizes": "57x57",
173+
"static-file": "favicon/apple-touch-icon-57x57.png",
174+
"type": "image/png",
175+
},
176+
{
177+
"rel": "apple-touch-icon",
178+
"sizes": "60x60",
179+
"static-file": "favicon/apple-touch-icon-60x60.png",
180+
"type": "image/png",
181+
},
182+
{
183+
"rel": "apple-touch-icon",
184+
"sizes": "72x72",
185+
"static-file": "favicon/apple-touch-icon-72x72.png",
186+
"type": "image/png",
187+
},
188+
{
189+
"rel": "apple-touch-icon",
190+
"sizes": "76x76",
191+
"static-file": "favicon/apple-touch-icon-76x76.png",
192+
"type": "image/png",
193+
},
194+
{
195+
"rel": "apple-touch-icon",
196+
"sizes": "114x114",
197+
"static-file": "favicon/apple-touch-icon-114x114.png",
198+
"type": "image/png",
199+
},
200+
{
201+
"rel": "apple-touch-icon",
202+
"sizes": "120x120",
203+
"static-file": "favicon/apple-touch-icon-120x120.png",
204+
"type": "image/png",
205+
},
206+
{
207+
"rel": "apple-touch-icon",
208+
"sizes": "144x144",
209+
"static-file": "favicon/apple-touch-icon-144x144.png",
210+
"type": "image/png",
211+
},
212+
{
213+
"rel": "apple-touch-icon",
214+
"sizes": "152x152",
215+
"static-file": "favicon/apple-touch-icon-152x152.png",
216+
"type": "image/png",
217+
},
218+
]
219+
132220
# Add any paths that contain custom static files (such as style sheets) here,
133221
# relative to this directory. They are copied after the builtin static files,
134222
# so a file named "default.css" will overwrite the builtin "default.css".
135-
#html_static_path = ['_static']
223+
html_static_path = ['_static']
136224

137225
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138226
# using the given strftime format.

requirements-doc.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
sphinx==5.2.1
22
sphinx-paramlinks==0.5.4
3+
sphinx-favicon==0.2

0 commit comments

Comments
 (0)