Skip to main content
Help us improve Python packaging – donate today!

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.

Release history Release notifications

This version
History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_email-0.1-py2.6.egg (5.0 kB) Copy SHA256 hash SHA256 Egg 2.6 Jan 29, 2011
sphinxcontrib-email-0.1.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None Jan 29, 2011

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page