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.

Source Distribution

sphinxcontrib_email-0.3.6.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_email-0.3.6-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib_email-0.3.6.tar.gz.

File metadata

  • Download URL: sphinxcontrib_email-0.3.6.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for sphinxcontrib_email-0.3.6.tar.gz
Algorithm Hash digest
SHA256 abccace14150985bbc7a1e9044d427e8ff3d9caafd255b9f0665f8b78b6645b8
MD5 5d950324d08928e7d8c98621ef8fd80b
BLAKE2b-256 9257b89465c5574334a750d2d5f603c235d2392d3777bef6799ef5fc13ef97a9

See more details on using hashes here.

File details

Details for the file sphinxcontrib_email-0.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_email-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c71a34f32af6d38f7fb8de361db057194ea609eb8b990be1f7e5db564c52dc25
MD5 7646ae4ee6aa908cd0055c611258e8cd
BLAKE2b-256 14ea2de2ce05d731981b67ef081c619a34cf961410966321f571e3773fd7e80a

See more details on using hashes here.

Supported by

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