sphinxcontrib-email

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

Installation

1. pip install sphinxcontrib-email

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 <user@myplace.org>`

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

:email:`user@myplace.org`

Renders as "user@myplace.org" with the appropriate mailto link