File tree Expand file tree Collapse file tree 1 file changed +17
-8
lines changed Expand file tree Collapse file tree 1 file changed +17
-8
lines changed Original file line number Diff line number Diff line change @@ -10,24 +10,25 @@ Sphinx builders.
10
10
This caption is automatically derived from the FontAwesome 5 class name
11
11
if not explicitly provided.
12
12
13
- In your ``conf.py``, add ``'icon`` to the ``extensions``
13
+ In your ``conf.py``, add ``'icon' `` to the ``extensions``
14
14
list.
15
15
16
16
.. example::
17
17
18
18
.. code-block:: rst
19
19
20
- Press the :icon:`windows` key. This has the caption ``windows icon`` .
20
+ Press the :icon:`edit` button .
21
21
22
- Press the :icon :`Windows logo <windows>` key. This has the caption
22
+ Press the :iconb :`Windows logo <windows>` key. This has the caption
23
23
``Windows logo``.
24
24
25
- Press the :icon:`windows` key. This has the caption ``windows icon`` .
25
+ Press the :icon:`edit` button .
26
26
27
- Press the :icon :`Windows logo <windows>` key. This has the caption
27
+ Press the :iconb :`Windows logo <windows>` key. This has the caption
28
28
``Windows logo``.
29
29
30
- The following icons are supported:
30
+ Regular Icons (``icon``)
31
+ ------------------------
31
32
32
33
.. list-table::
33
34
@@ -52,8 +53,8 @@ The following icons are supported:
52
53
* - ``exclamation-circle``
53
54
- :icon:`exclamation-circle`
54
55
55
- * - ``pencil``
56
- - :icon:`pencil`
56
+ * - ``pencil-alt ``
57
+ - :icon:`pencil-alt `
57
58
58
59
* - ``save``
59
60
- :icon:`save`
@@ -63,3 +64,11 @@ The following icons are supported:
63
64
64
65
* - ``trash-alt``
65
66
- :icon:`trash-alt`
67
+
68
+ Brand Icons (``iconb``)
69
+ -----------------------
70
+
71
+ .. list-table::
72
+
73
+ * - ``windows``
74
+ - :iconb:`windows`
You can’t perform that action at this time.
0 commit comments