Skip to main content

Sphinx email obfuscation extension

Project description

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

History
=======

0.1
First public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-email-0.1.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_email-0.1-py2.6.egg (5.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page