sphinxnotes-strike

An extension that adds strikethrough text support to Sphinx.

• Documentation: https://sphinx.silverrainz.me/strike

• Source: https://github.com/sphinx-notes/strike

• Changelog: https://sphinx.silverrainz.me/strike/changelog.html

• Tracker: https://github.com/sphinx-notes/strike/issues

• Download: https://pypi.org/project/sphinxnotes-strike/#files

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

Contents

• Change Log
  • 1.2
  • 1.1
  • 1.0
  • 1.0a0

The Sphinx Notes Project

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

The Sphinx Notes Project

• Home
• Blog
• PyPI