Skip to content

Commit bee1e35

Browse files
committed
doc: remove strike role example in roles document
Support for the `strike` class is outlined in detail in the class hints guide and does not also need to be in the custom roles document; removing. Signed-off-by: James Knight <[email protected]>
1 parent 5aa8c4b commit bee1e35

File tree

1 file changed

+0
-16
lines changed

1 file changed

+0
-16
lines changed

doc/roles.rst

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -203,22 +203,6 @@ generated Confluence documents.
203203
Strikethrough
204204
-------------
205205

206-
.. note::
207-
208-
This role can be used to help a user observe the ability to strikethrough
209-
text on a Confluence page; however, this role only applies to Confluence
210-
builders. Users attempting to support multiple builders (such as the
211-
``html`` builder), are recommended to use a ``class`` hint instead. This
212-
extension supports an applied ``strike`` class on text as an indication
213-
that the text should have a strikethrough format. For example:
214-
215-
.. code-block:: rst
216-
217-
.. role:: strike
218-
:class: strike
219-
220-
This is a :strike:`strikeme` example.
221-
222206
The following role can be used to explicitly define strikethrough text into
223207
generated Confluence documents.
224208

0 commit comments

Comments
 (0)