sphinxcontrib-email

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 <[e-mail]>

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

.. code::

:email:[e-mail]

Renders as "[e-mail]" with the appropriate mailto link