Skip to content

Commit 9761c29

Browse files
committed
Add brand icons, update pencil icon
1 parent 5464a90 commit 9761c29

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

source/reference/icon.txt

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,25 @@ Sphinx builders.
1010
This caption is automatically derived from the FontAwesome 5 class name
1111
if not explicitly provided.
1212

13-
In your ``conf.py``, add ``'icon`` to the ``extensions``
13+
In your ``conf.py``, add ``'icon'`` to the ``extensions``
1414
list.
1515

1616
.. example::
1717

1818
.. code-block:: rst
1919

20-
Press the :icon:`windows` key. This has the caption ``windows icon``.
20+
Press the :icon:`edit` button.
2121

22-
Press the :icon:`Windows logo <windows>` key. This has the caption
22+
Press the :iconb:`Windows logo <windows>` key. This has the caption
2323
``Windows logo``.
2424

25-
Press the :icon:`windows` key. This has the caption ``windows icon``.
25+
Press the :icon:`edit` button.
2626

27-
Press the :icon:`Windows logo <windows>` key. This has the caption
27+
Press the :iconb:`Windows logo <windows>` key. This has the caption
2828
``Windows logo``.
2929

30-
The following icons are supported:
30+
Regular Icons (``icon``)
31+
------------------------
3132

3233
.. list-table::
3334

@@ -52,8 +53,8 @@ The following icons are supported:
5253
* - ``exclamation-circle``
5354
- :icon:`exclamation-circle`
5455

55-
* - ``pencil``
56-
- :icon:`pencil`
56+
* - ``pencil-alt``
57+
- :icon:`pencil-alt`
5758

5859
* - ``save``
5960
- :icon:`save`
@@ -63,3 +64,11 @@ The following icons are supported:
6364

6465
* - ``trash-alt``
6566
- :icon:`trash-alt`
67+
68+
Brand Icons (``iconb``)
69+
-----------------------
70+
71+
.. list-table::
72+
73+
* - ``windows``
74+
- :iconb:`windows`

0 commit comments

Comments
 (0)