sphinxcontrib-email
![[Latest PyPI version]](https://pypi-camo.freetls.fastly.net/96e738099fe20f3e5578cef6ad7eced323733109/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f737068696e78636f6e747269622d73636d2e737667)
![[Supported Python versions]](https://pypi-camo.freetls.fastly.net/f1eacddd8ca17c4b5840722938a31aa76434527e/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f737068696e78636f6e747269622d73636d2e737667)
![[pre-commit: enabled]](https://pypi-camo.freetls.fastly.net/4abb85bbb3e31fcf7cd1be5a440d77a3e1a9d6fe/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7072652d2d636f6d6d69742d656e61626c65642d627269676874677265656e2e7376673f6c6f676f3d7072652d636f6d6d6974266c6f676f436f6c6f723d7768697465)
![[pre-commit.ci status]](https://pypi-camo.freetls.fastly.net/48402cf52cb3a292f66f50c8eef6ea247099019c/68747470733a2f2f726573756c74732e7072652d636f6d6d69742e63692f62616467652f6769746875622f737068696e782d636f6e747269622f73636d2f6d61737465722e737667)
![[Code style: black]](https://pypi-camo.freetls.fastly.net/fbfdc7754183ecf079bc71ddeabaf88f6cbc5c00/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667)
![[Code style: prettier]](https://pypi-camo.freetls.fastly.net/aedf3c98fb8318fe049fa1c12589c7555ff0b9c6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d6666363962342e737667)
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 = 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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-email 0.3.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib_email-0.3.6.tar.gz | 9.6 kB | Without provenance | Details for sphinxcontrib_email-0.3.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_email-0.3.6-py3-none-any.whl | Python 3 | none | any | Details for sphinxcontrib_email-0.3.6-py3-none-any.whl |
Total release size: 15.9 kB
Release files / sphinxcontrib_email-0.3.6.tar.gz
| Download URL | sphinxcontrib_email-0.3.6.tar.gz |
|---|---|
| Size | 9.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
abccace14150985bbc7a1e9044d427e8ff3d9caafd255b9f0665f8b78b6645b8
|
|
BLAKE2b-256 checksum How to use checksums |
9257b89465c5574334a750d2d5f603c235d2392d3777bef6799ef5fc13ef97a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Release files / sphinxcontrib_email-0.3.6-py3-none-any.whl
| Download URL | sphinxcontrib_email-0.3.6-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c71a34f32af6d38f7fb8de361db057194ea609eb8b990be1f7e5db564c52dc25
|
|
BLAKE2b-256 checksum How to use checksums |
14ea2de2ce05d731981b67ef081c619a34cf961410966321f571e3773fd7e80a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Security for sphinxcontrib-email 0.3.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
