@@ -33,21 +33,57 @@ To configure, *conf.py*:
33
33
34
34
*html_theme_options * example:
35
35
36
- .. code-block :: python
37
-
38
- html_theme_options = {
39
- ' logo' : ' img/logo.svg' ,
40
- ' github_user' : ' git-pull' ,
41
- ' github_repo' : ' alagitpull' ,
42
- ' github_type' : ' star' ,
43
- ' github_banner' : True ,
44
- ' projects' : {},
45
- ' project_name' : ' my project name' ,
46
- }
36
+ .. code-block :: python
37
+
38
+ html_theme_options = {
39
+ ' logo' : ' img/logo.svg' ,
40
+ ' github_user' : ' git-pull' ,
41
+ ' github_repo' : ' alagitpull' ,
42
+ ' github_type' : ' star' ,
43
+ ' github_banner' : True ,
44
+ ' projects' : {},
45
+ ' project_name' : ' my project name' ,
46
+ }
47
47
48
48
For an example of ``html_theme_options['projects'] `` see the
49
49
*alagitpull/__init__.py * file.
50
50
51
+ Example of using an optional variable such as
52
+ ``theme_show_meta_app_icons_tags ``:
53
+
54
+ .. code-block :: python
55
+
56
+ html_theme_options = {
57
+ # ...usual stuff, as above, and
58
+ ' project_description' : ' description of project'
59
+ }
60
+
61
+
62
+ .. code-block :: html
63
+
64
+ {%- if theme_show_meta_app_icon_tags == true %}
65
+ <meta name =" theme-color" content =" #ffffff" >
66
+ <meta name =" application-name" content =" {{ theme_project_description }}" >
67
+
68
+ <link rel =" shortcut icon" href =" /_static/favicon.ico" >
69
+ <link rel =" icon" type =" image/png" sizes =" 512x512" href =" /_static/img/icons/icon-512x512.png" >
70
+ <link rel =" icon" type =" image/png" sizes =" 192x192" href =" /_static/img/icons/icon-192x192.png" >
71
+ <link rel =" icon" type =" image/png" sizes =" 32x32" href =" /_static/img/icons/icon-32x32.png" >
72
+ <link rel =" icon" type =" image/png" sizes =" 96x96" href =" /_static/img/icons/icon-96x96.png" >
73
+ <link rel =" icon" type =" image/png" sizes =" 16x16" href =" /_static/img/icons/icon-16x16.png" >
74
+
75
+ <!-- Apple -->
76
+ <meta name =" apple-mobile-web-app-title" content =" {{ theme_project_name }}" >
77
+
78
+ <link rel =" apple-touch-icon" sizes =" 192x192" href =" /_static/img/icons/icon-192x192.png" >
79
+ <link rel =" mask-icon" href =" /_static/img/{{ theme_project_name }}.svg" color =" grey" >
80
+
81
+ <!-- Microsoft -->
82
+ <meta name =" msapplication-TileColor" content =" #ffffff" >
83
+ <meta name =" msapplication-TileImage" content =" /_static/img/icons/ms-icon-144x144.png" >
84
+ {% endif -%}
85
+
86
+
51
87
Variables
52
88
"""""""""
53
89
0 commit comments