sphinxcontrib-email 0.1

sphinxcontrib-email
===================

This package contains sphinxcontrb.email, an email obfuscator for
Sphinx-based documentation.


Installation
============
::

pip install sphinxcontrib-email


Configuration
=============

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

::

extensions = [ 'sphinxcontrib.email' ]


Usage
=====

To obfuscate an email address use something like::

:email:`Name Surname <[e-mail]>`
: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

History
=======

0.1
First public release.