sphinxcontrib-email


Namesphinxcontrib-email JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummarySphinx email obfuscation extension
upload_time2020-09-16 18:11:32
maintainer
docs_urlNone
authorChristian Knittl-Frank
requires_python>=3.7
licenseBSD-3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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]



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "sphinxcontrib-email",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Christian Knittl-Frank",
    "author_email": "lcnittl@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/00/ecf5ee81be6f2f66e6be42d6fbf6584395f152d79e5168c5acdf31fa689c/sphinxcontrib-email-0.3.0.tar.gz",
    "platform": "",
    "description": "sphinxcontrib-email\n===================\n\n|badge:pypi-version| |badge:py-versions|\n|badge:pre-commit| |badge:black| |badge:prettier|\n\nThis package provides sphinxcontrib.email, an email obfuscator for\nSphinx-based documentation.\n\n\nInstallation\n------------\n\n1. ``pip install sphinxcontrib-email``\n\n\nConfiguration\n-------------\n\n1. Add ``'sphinxcontrib.email'`` to the ``extensions`` list in ``conf.py``.\n\n   .. code::\n\n      extensions = [ 'sphinxcontrib.email' ]\n\n\nUsage\n-----\n\nAuto Mode\n^^^^^^^^^\n\nIn ``conf.py``, set\n\n.. code::\n\n   email_automode = True\n\nto automatically obfuscate all ``mailto`` links.\n\n\nManual Mode\n^^^^^^^^^^^\n\nTo obfuscate an email address use the ``email`` role:\n\n.. code::\n\n   :email:`Name Surname <user@myplace.org>`\n\nRenders as \"Name Surname\" with the appropriate mailto link.\n\n.. code::\n\n   :email:`user@myplace.org`\n\nRenders as \"user@myplace.org\" with the appropriate mailto link\n\n\nDisclaimer\n----------\n\nThe obfuscation code was adapted from http://pypi.python.org/pypi/bud.nospam where it\nwas released by Kevin Teague <kevin at bud ca> under a BSD license.\n\n\n.. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-email\n   :target: https://pypi.org/project/sphinxcontrib-email/\n   :alt: [Latest PyPI version]\n.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-email\n   :target: https://pypi.org/project/sphinxcontrib-email/\n   :alt: [Supported Python versions]\n.. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n   :target: https://github.com/pre-commit/pre-commit\n   :alt: [pre-commit: enabled]\n.. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000\n   :target: https://github.com/psf/black\n   :alt: [Code style: black]\n.. |badge:prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4\n   :target: https://github.com/prettier/prettier\n   :alt: [Code style: prettier]\n\n\n",
    "bugtrack_url": null,
    "license": "BSD-3",
    "summary": "Sphinx email obfuscation extension",
    "version": "0.3.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8100d1883444fc7b2739ba56a6748522",
                "sha256": "9ce27baff6a62dd9144247c03778d589679d9589b9a55cf6fd316449bd713313"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_email-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8100d1883444fc7b2739ba56a6748522",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5894,
            "upload_time": "2020-09-16T18:11:31",
            "upload_time_iso_8601": "2020-09-16T18:11:31.656754Z",
            "url": "https://files.pythonhosted.org/packages/4e/df/bb2894872f610f23db7bf4e510d9556d996a402ac6c2881355ef26b466a7/sphinxcontrib_email-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2e2be118e13c09aaaa295883627de8e6",
                "sha256": "382bf84d6259e124c95d4c8c09540b3eb89d4d819ade6cd6e1200298755ab06a"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-email-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e2be118e13c09aaaa295883627de8e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6500,
            "upload_time": "2020-09-16T18:11:32",
            "upload_time_iso_8601": "2020-09-16T18:11:32.618782Z",
            "url": "https://files.pythonhosted.org/packages/f7/00/ecf5ee81be6f2f66e6be42d6fbf6584395f152d79e5168c5acdf31fa689c/sphinxcontrib-email-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-09-16 18:11:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "sphinxcontrib-email"
}
        
Elapsed time: 0.19094s