docs: Works with sphinxnotes-strike

sphinx-notes · Jan 13, 2024 · bdeeee2 · bdeeee2
1 parent f0794eb
commit bdeeee2
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -144,7 +144,10 @@
     'parsed_literal': (['literal'], True),
     'parsed_emphasis': (['emphasis'], True),
     'literal_issue': ['literal', 'issue'],
+    'literal_strike': ['literal', 'strike'],
 }
 
+extensions.append('sphinxnotes.strike')
+
 # DOG FOOD CONFIGURATION END
 # 
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -123,6 +123,25 @@ then comboroles creates a ``literal_issue`` role based on it:
 
 .. _sphinx.ext.extlinks: https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
 
+``sphinxnotes.strike``
+----------------------
+
+:parsed_literal:`sphinxnotes.strike_` is an extension that adds
+:del:`strikethrough text` support to Sphinx.
+
+.. code:: python
+
+   comboroles_roles = {
+      'literal_strike': ['literal', 'strike'],
+   }
+
+=========================== ======================
+``:strike:`text```          :strike:`text`
+``:literal_strike:`text```` :literal_strike:`text`
+=========================== ======================
+
+.. _sphinxnotes-strike: https://sphinx.silverrainz.me/strike/
+
 .. _limitation:
 
 Limitation

diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,7 @@ docs = [
     "sphinx_design",
     "sphinx_copybutton",
     "sphinxcontrib-gtagjs",
+    "sphinxnotes-strike",
 ]
 
 [project.urls]