![[Latest PyPI version]](https://img.shields.io/pypi/v/sphinxcontrib-scm.svg)
![[Supported Python versions]](https://img.shields.io/pypi/pyversions/sphinxcontrib-scm.svg)
![[pre-commit: enabled]](https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&logoColor=white){kind=icon}
![[pre-commit.ci status]](https://results.pre-commit.ci/badge/github/sphinx-contrib/scm/master.svg){kind=icon}
![[Code style: black]](https://img.shields.io/badge/code%20style-black-000000.svg){kind=icon}
![[Code style: prettier]](https://img.shields.io/badge/code_style-prettier-ff69b4.svg){kind=icon}
This package provides sphinxcontrib.email, an email obfuscator for
Sphinx-based documentation.
pip install sphinxcontrib-email
Support for python 3.6 will be dropped after its EOL on 2021-12-23.
Add
'sphinxcontrib.email'to theextensionslist inconf.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