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-scm.svg
:target: https://pypi.org/project/sphinxcontrib-scm
:alt: [Latest PyPI version]
.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-scm.svg
:target: https://pypi.org/project/sphinxcontrib-scm
: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/scm/master.svg
:target: https://results.pre-commit.ci/latest/github/sphinx-contrib/scm/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``
Support for python 3.6 will be dropped after its EOL on 2021-12-23.
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
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-contrib/email",
"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/92/57/b89465c5574334a750d2d5f603c235d2392d3777bef6799ef5fc13ef97a9/sphinxcontrib_email-0.3.6.tar.gz",
"platform": null,
"description": "sphinxcontrib-email\n===================\n\n|badge:pypi-version| |badge:py-versions|\n|badge:pre-commit| |badge:pre-commit.ci|\n|badge:black| |badge:prettier|\n\n.. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-scm.svg\n :target: https://pypi.org/project/sphinxcontrib-scm\n :alt: [Latest PyPI version]\n.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-scm.svg\n :target: https://pypi.org/project/sphinxcontrib-scm\n :alt: [Supported Python versions]\n.. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: [pre-commit: enabled]\n.. |badge:pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/sphinx-contrib/scm/master.svg\n :target: https://results.pre-commit.ci/latest/github/sphinx-contrib/scm/master\n :alt: [pre-commit.ci status]\n.. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\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.svg\n :target: https://github.com/prettier/prettier\n :alt: [Code style: prettier]\n\n\nThis package provides ``sphinxcontrib.email``, an email obfuscator for\nSphinx-based documentation.\n\n\nInstallation\n------------\n\n1. ``pip install sphinxcontrib-email``\n\nSupport for python 3.6 will be dropped after its EOL on 2021-12-23.\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",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Sphinx email obfuscation extension",
"version": "0.3.6",
"project_urls": {
"Download": "http://pypi.python.org/pypi/sphinxcontrib-email",
"GitHub: issues": "https://github.com/sphinx-contrib/email/issues",
"GitHub: repo": "https://github.com/sphinx-contrib/email",
"Homepage": "https://github.com/sphinx-contrib/email"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14ea2de2ce05d731981b67ef081c619a34cf961410966321f571e3773fd7e80a",
"md5": "7646ae4ee6aa908cd0055c611258e8cd",
"sha256": "c71a34f32af6d38f7fb8de361db057194ea609eb8b990be1f7e5db564c52dc25"
},
"downloads": -1,
"filename": "sphinxcontrib_email-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7646ae4ee6aa908cd0055c611258e8cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6294,
"upload_time": "2023-01-10T18:07:53",
"upload_time_iso_8601": "2023-01-10T18:07:53.061319Z",
"url": "https://files.pythonhosted.org/packages/14/ea/2de2ce05d731981b67ef081c619a34cf961410966321f571e3773fd7e80a/sphinxcontrib_email-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9257b89465c5574334a750d2d5f603c235d2392d3777bef6799ef5fc13ef97a9",
"md5": "5d950324d08928e7d8c98621ef8fd80b",
"sha256": "abccace14150985bbc7a1e9044d427e8ff3d9caafd255b9f0665f8b78b6645b8"
},
"downloads": -1,
"filename": "sphinxcontrib_email-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "5d950324d08928e7d8c98621ef8fd80b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9577,
"upload_time": "2023-01-10T18:07:54",
"upload_time_iso_8601": "2023-01-10T18:07:54.526933Z",
"url": "https://files.pythonhosted.org/packages/92/57/b89465c5574334a750d2d5f603c235d2392d3777bef6799ef5fc13ef97a9/sphinxcontrib_email-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-10 18:07:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-contrib",
"github_project": "email",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinxcontrib-email"
}
JSON
