Sphinx email obfuscation extension
Project description
![[Latest PyPI version]](https://pypi-camo.freetls.fastly.net/f56d5efc84bbc947c024783bc0c4c11b458a1932/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f737068696e78636f6e747269622d656d61696c)
![[Supported Python versions]](https://pypi-camo.freetls.fastly.net/a0cdeba9023c447ab6a31854a770fe11ada28c9d/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f737068696e78636f6e747269622d656d61696c)
![[pre-commit: enabled]](https://pypi-camo.freetls.fastly.net/d861174d9af84b80d393b2e7c89badabc5e04097/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7072652d2d636f6d6d69742d656e61626c65642d627269676874677265656e3f6c6f676f3d7072652d636f6d6d6974266c6f676f436f6c6f723d7768697465)
![[Code style: black]](https://pypi-camo.freetls.fastly.net/8cf8140a39e7996d456d498165ff62b11724c1dc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d303030303030)
![[Code style: prettier]](https://pypi-camo.freetls.fastly.net/1914041f87a5ebbabc252813052b78f7bcdda5d6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d666636396234)
This package provides sphinxcontrib.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
Auto Mode
In conf.py, set
email_automode = Trueto automatically obfuscate all mailto links.
Manual Mode
To obfuscate an email address use the email role:
: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
Disclaimer
The obfuscation code was adapted from http://pypi.python.org/pypi/bud.nospam where it was released by Kevin Teague <kevin at bud ca> under a BSD license.
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.3.1.tar.gz.
File metadata
- Download URL: sphinxcontrib-email-0.3.1.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5dae9ae6aec433d5ebffa22fd380180af55b8c6eda7e38da82b4e243472500df |
|
| MD5 | 89a79b319a66b9c2d9ae51f0975b64cd |
|
| BLAKE2b-256 | 307a5bbaa2c0162cb180e5a9e7f67dff4d7345ce80a646e0c8be14d090804797 |
File details
Details for the file sphinxcontrib_email-0.3.1-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_email-0.3.1-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3534c0dc91078276c3d6c2050dca3201ac9542f719e49486bf636cd48cadc229 |
|
| MD5 | c37ab3d228b3be28b9d6833edc746dc2 |
|
| BLAKE2b-256 | 295116ba45cc2de1c63f10f7457f35bdb6dff8122522299dcdaefc0cf7ab4bd5 |
