Skip to main content

Sphinx email obfuscation extension

Project description

[Latest PyPI version] [Supported Python versions] [pre-commit: enabled] [pre-commit.ci status] [Code style: black] [Code style: prettier]

This package provides sphinxcontrib.email, an email obfuscator for Sphinx-based documentation.

Installation

  1. pip install sphinxcontrib-email

Support for python 3.6 will be dropped after its EOL on 2021-12-23.

Configuration

  1. 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

Project details


Download files

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

Files for sphinxcontrib-email, version 0.3.5
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_email-0.3.5.tar.gz (9.0 kB) File type Source Python version None Upload date Hashes View
Filename, size sphinxcontrib_email-0.3.5-py3-none-any.whl (6.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page