semvec/pypi-packages huggingface dataset:
sphinxcontrib-email2 0.3.dev20200619
Sphinx email obfuscation extension
License: BSD

.. note::

    This package is a fork of sphinxcontrb.email,
    but it named sphinxcontrb.email2 to prevent conflict on pypi.

=========================
 sphinxcontrib-email
=========================

This package contains sphinxcontrb.email, an email obfuscator for
Sphinx-based documentation.


Installation
============

1. ``pip install sphinxcontrib-email2``

Configuration
=============

1. Add ``'sphinxcontrib.email'`` to the ``extensions`` list in ``conf.py``.

  ::

    extensions = [ 'sphinxcontrib.email' ]


Usage
=====

To obfuscate an email address use something like::

    :email:`Name Surname <user@myplace.org>`
    :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

History
=======

0.1
  First public release.
0.2
  Python 3 compatibility.
0.3
  Rename package.