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.
===================
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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinxcontrib-email-0.1.tar.gz.
File metadata
- Download URL: sphinxcontrib-email-0.1.tar.gz
- Upload date:
- Size: 3.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1967333fb575549b6e1e3afeac1c73b58e1f5fffcd5eea0e38110ba13c2c372a |
|
| MD5 | de53b61965da3255fd8fd91784548883 |
|
| BLAKE2b-256 | bf1a173a6b211d42f28317d3b56ae2b6b88fc87fa3f51c8f5d72b792f83a0d34 |
File details
Details for the file sphinxcontrib_email-0.1-py2.6.egg.
File metadata
- Download URL: sphinxcontrib_email-0.1-py2.6.egg
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 668620104dedc84c0c56c12f16b173e03d1a5f3db739778ce2ec3adcc531fd5e |
|
| MD5 | 6a161a9d591f9c25b861f28790719d2f |
|
| BLAKE2b-256 | 43843ca0271af0bfbe034d82f975985111227385185b95c9febbf3e50b110768 |
