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


Release history Release notifications

This version

0.1

Download files

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

Files for sphinxcontrib-email, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_email-0.1-py2.6.egg (5.0 kB) File type Egg Python version 2.6 Upload date Hashes View
Filename, size sphinxcontrib-email-0.1.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page