|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.
pip install sphinxcontrib-emailSupport for python 3.6 will be dropped after its EOL on 2021-12-23.
Add 'sphinxcontrib.email' to the extensions list in conf.py.
.. code::
extensions = [ 'sphinxcontrib.email' ]
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
FAQs
Sphinx email obfuscation extension
We found that sphinxcontrib-email demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.