aboutsummaryrefslogtreecommitdiff
path: root/dotfiles/cheat/sphinxdoc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dotfiles/cheat/sphinxdoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/dotfiles/cheat/sphinxdoc b/dotfiles/cheat/sphinxdoc
new file mode 100644
index 0000000..3e081d7
--- /dev/null
+++ b/dotfiles/cheat/sphinxdoc
@@ -0,0 +1,24 @@
+# Add a strike html component
+
+In conf.py file:
+
+```
+rst_prolog = """
+.. role:: strike
+"""
+```
+
+Extend the layout theme template `layout.html` with:
+
+```
+{% extends "!layout.html" %}
+{% set css_files = css_files + ["_static/style.css"] %}
+```
+
+In the `style.css`:
+
+```
+.strike {
+ text-decoration: line-through;
+}
+```