Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

sphinxcontrib-email

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sphinxcontrib-email

Sphinx email obfuscation extension

  • 0.3.6
  • PyPI
  • Socket score

Maintainers
1

sphinxcontrib-email

|badge:pypi-version| |badge:py-versions| |badge:pre-commit| |badge:pre-commit.ci| |badge:black| |badge:prettier|

.. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-scm.svg :target: https://pypi.org/project/sphinxcontrib-scm :alt: [Latest PyPI version] .. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-scm.svg :target: https://pypi.org/project/sphinxcontrib-scm :alt: [Supported Python versions] .. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&logoColor=white :target: https://github.com/pre-commit/pre-commit :alt: [pre-commit: enabled] .. |badge:pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/sphinx-contrib/scm/master.svg :target: https://results.pre-commit.ci/latest/github/sphinx-contrib/scm/master :alt: [pre-commit.ci status] .. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: [Code style: black] .. |badge:prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg :target: https://github.com/prettier/prettier :alt: [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.

    .. code::

    extensions = [ 'sphinxcontrib.email' ]

Usage

Auto Mode ^^^^^^^^^

In conf.py, set

.. code::

email_automode = True

to automatically obfuscate all mailto links.

Manual Mode ^^^^^^^^^^^

To obfuscate an email address use the email role:

.. code::

:email:Name Surname <user@myplace.org>

Renders as "Name Surname" with the appropriate mailto link.

.. code::

:email:user@myplace.org

Renders as "user@myplace.org" with the appropriate mailto link

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc