sphinxnotes-strike#

Documentation Status Open Source License PyPI Package PyPI Package Downloads

An extension that adds strikethrough text support to Sphinx.

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:

:strike:`Sphinx`

Sphinx

Role del also works:

:del:`Sphinx`

Sphinx

Contents#

The Sphinx Notes Project#

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project