https://github.com/sphinx-contrib/email

https://github.com/sphinx-contrib/email

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/email
• Owner: sphinx-contrib
• License: bsd-3-clause
• Created: 2017-09-28T10:40:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T23:15:17.000Z (9 months ago)
• Last Synced: 2024-08-08T12:07:57.220Z (9 months ago)
• Language: Python
• Size: 64.5 KB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
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-email.svg

   :target: https://pypi.org/project/sphinxcontrib-email

   :alt: [Latest PyPI version]

.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-email.svg

   :target: https://pypi.org/project/sphinxcontrib-email

   :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/email/master.svg

   :target: https://results.pre-commit.ci/latest/github/sphinx-contrib/email/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``

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 `

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

.. code::

   :email:`[email protected]`

Renders as "[email protected]" with the appropriate mailto link