Skip to content

Commit 2ff838a

Browse files
committed
Update README
1 parent 487951c commit 2ff838a

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

README.rst

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,24 @@ sphinxcontrib-email
44
|badge:pypi-version| |badge:py-versions|
55
|badge:pre-commit| |badge:black| |badge:prettier|
66

7-
This package provides sphinxcontrib.email, an email obfuscator for
7+
.. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-email.svg
8+
:target: https://pypi.org/project/sphinxcontrib-email/
9+
:alt: [Latest PyPI version]
10+
.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-email.svg
11+
:target: https://pypi.org/project/sphinxcontrib-email/
12+
:alt: [Supported Python versions]
13+
.. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&logoColor=white
14+
:target: https://github.com/pre-commit/pre-commit
15+
:alt: [pre-commit: enabled]
16+
.. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
17+
:target: https://github.com/psf/black
18+
:alt: [Code style: black]
19+
.. |badge:prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
20+
:target: https://github.com/prettier/prettier
21+
:alt: [Code style: prettier]
22+
23+
24+
This package provides ``sphinxcontrib.email``, an email obfuscator for
825
Sphinx-based documentation.
926

1027

@@ -55,27 +72,3 @@ Renders as "Name Surname" with the appropriate mailto link.
5572
5673
5774
Renders as "[email protected]" with the appropriate mailto link
58-
59-
60-
Disclaimer
61-
----------
62-
63-
The obfuscation code was adapted from http://pypi.python.org/pypi/bud.nospam where it
64-
was released by Kevin Teague <kevin at bud ca> under a BSD license.
65-
66-
67-
.. |badge:pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-email
68-
:target: https://pypi.org/project/sphinxcontrib-email/
69-
:alt: [Latest PyPI version]
70-
.. |badge:py-versions| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-email
71-
:target: https://pypi.org/project/sphinxcontrib-email/
72-
:alt: [Supported Python versions]
73-
.. |badge:pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
74-
:target: https://github.com/pre-commit/pre-commit
75-
:alt: [pre-commit: enabled]
76-
.. |badge:black| image:: https://img.shields.io/badge/code%20style-black-000000
77-
:target: https://github.com/psf/black
78-
:alt: [Code style: black]
79-
.. |badge:prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4
80-
:target: https://github.com/prettier/prettier
81-
:alt: [Code style: prettier]

0 commit comments

Comments
 (0)