Sphinx email obfuscation extension
Project description
This package provides sphinxcontrib.email, an email obfuscator for Sphinx-based documentation.
Installation
- pip install sphinxcontrib-email
Support for python 3.6 will be dropped after its EOL on 2021-12-23.
Configuration
Add 'sphinxcontrib.email' to the extensions list in conf.py.
extensions = [ 'sphinxcontrib.email' ]
Usage
Auto Mode
In conf.py, set
email_automode = True
to 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
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.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size sphinxcontrib_email-0.3.5-py3-none-any.whl (6.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
| Filename, size sphinxcontrib_email-0.3.5.tar.gz (9.0 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for sphinxcontrib_email-0.3.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2387fc0691f3a4ed9c0b7d32acce5a42495340cc45f6e759a1b38e1eb86fe888 |
|
| MD5 | cff14f3b695b16405d129bb729c3e2e1 |
|
| BLAKE2-256 | 1563b9ab2c1777b482776b863932460753eb85fd975329bb32885bbbef47cc41 |
Close
Hashes for sphinxcontrib_email-0.3.5.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 74738235afd602b7f692d2b62b4582034e8bb32dbcaa7ecab34be985d8bae590 |
|
| MD5 | eb22a1faf773b7529522317a61768165 |
|
| BLAKE2-256 | 8f0ed7b4c70d577ae6c76b4721040dbab8e8812603850f1f23168d129351b588 |