Sphinx email obfuscation extension

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for lcnittl from gravatar.com lcnittl

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page