Metadata-Version: 2.1
Name: sphinxcontrib-email
Version: 0.3.0
Summary: Sphinx email obfuscation extension
Home-page: UNKNOWN
Author: Christian Knittl-Frank
Author-email: lcnittl@gmail.com
License: BSD-3
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-email
Project-URL: GitHub: repo, https://github.com/sphinx-contrib/email
Project-URL: GitHub: issues, https://github.com/sphinx-contrib/email/issues
Description: sphinxcontrib-email
        ===================
        
        |badge:pypi-version| |badge:py-versions|
        |badge:pre-commit| |badge:black| |badge: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 <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
        
        
        Disclaimer
        ----------
        
        The obfuscation code was adapted from http://pypi.python.org/pypi/bud.nospam where it
        was released by Kevin Teague <kevin at bud ca> under a BSD license.
        
        
        .. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-email
           :target: https://pypi.org/project/sphinxcontrib-email/
           :alt: [Latest PyPI version]
        .. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-email
           :target: https://pypi.org/project/sphinxcontrib-email/
           :alt: [Supported Python versions]
        .. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
           :target: https://github.com/pre-commit/pre-commit
           :alt: [pre-commit: enabled]
        .. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000
           :target: https://github.com/psf/black
           :alt: [Code style: black]
        .. |badge:prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4
           :target: https://github.com/prettier/prettier
           :alt: [Code style: prettier]
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
