sphinx-toolbox / email

sphinxcontrib-email

This package provides sphinxcontrib.email, an email obfuscator for Sphinx-based documentation.

Installation

1. pip install sphinxcontrib-email

Support for python 3.6 will be dropped after its EOL on 2021-12-23.

Configuration

1. Add 'sphinxcontrib.email' to the extensions list in conf.py.

   extensions = [ 'sphinxcontrib.email' ]

Usage

Auto Mode

In conf.py, set

email_automode = True

to automatically obfuscate all mailto links.

Manual Mode

To obfuscate an email address use the email role:

:email:`Name Surname <[e-mail]>`

Renders as "Name Surname" with the appropriate mailto link.

:email:`[e-mail]`

Renders as "[e-mail]" with the appropriate mailto link