sphinxnotes-strike¶
Introduction¶
An extension that adds strikethrough text support to Sphinx.
Getting Started¶
Note
We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.
First, downloading extension from PyPI:
$ pip install sphinxnotes-strike
Then, add the extension name to extensions
configuration item in your
conf.py
:
extensions = [
# …
'sphinxnotes.strike',
# …
]
Use role strike
to add text with a strikethrough:
|
Sphinx |
Role del
also works:
|
Sphinx |
Contents¶
Contents
The Sphinx Notes Project¶
The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.