Metadata-Version: 1.1
Name: sphinxcontrib-email
Version: 0.1
Summary: Sphinx email obfuscation extension
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Kevin Teague
Author-email: kevin@bud.ca
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-email
Description-Content-Type: UNKNOWN
Description: =========================
         sphinxcontrib-email
        =========================
        
        This package contains sphinxcontrb.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``.
        
          ::
        
            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.
        
        
Platform: any
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: Topic :: Documentation
Classifier: Topic :: Utilities
