sphinxcontrib-email

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

Installation

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

Add 'sphinxcontrib.email' to the extensions list in conf.py.
```
extensions = [ 'sphinxcontrib.email' ]
```

In conf.py, set

email_automode = True

to automatically obfuscate all mailto links.

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