Fix README layout (attempt 1) (#1745)

vacanza · Mar 30, 2024 · bda590c · bda590c
1 parent 0e8a8cf
commit bda590c
Showing 1 changed file with 53 additions and 49 deletions.
diff --git a/README.rst b/README.rst
@@ -1,69 +1,73 @@
-===============
-python-holidays
-===============
+========
+holidays
+========
 
 A fast, efficient Python library for generating country- and subdivision- (e.g.
 state or province) specific sets of government-designated holidays on the fly.
 It aims to make determining whether a specific date is a holiday as fast and
 flexible as possible.
 
-:PyPI:
-    .. image:: https://img.shields.io/pypi/dm/holidays?color=%2341B5BE&style=flat
-        :target: https://pypi.org/project/holidays
-        :alt: Downloads
+.. |downloads| image:: https://img.shields.io/pypi/dm/holidays?color=%2341B5BE&style=flat
+    :target: https://pypi.org/project/holidays
+    :alt: PyPI downloads
 
-    .. image:: https://img.shields.io/pypi/v/holidays?color=%2341B5BE&label=version&style=flat
-        :target: https://pypi.org/project/holidays
-        :alt: PyPI version
+.. |version| image:: https://img.shields.io/pypi/v/holidays?color=%2341B5BE&label=version&style=flat
+    :target: https://pypi.org/project/holidays
+    :alt: PyPI version
 
-    .. image:: https://img.shields.io/github/release-date/vacanza/python-holidays?color=%2341B5BE&style=flat
-        :target: https://github.com/vacanza/python-holidays/releases
-        :alt: Release date
+.. |release date| image:: https://img.shields.io/github/release-date/vacanza/python-holidays?color=%2341B5BE&style=flat
+    :target: https://github.com/vacanza/python-holidays/releases
+    :alt: PyPI release date
 
-:CI/CD:
-    .. image:: https://img.shields.io/github/actions/workflow/status/vacanza/python-holidays/ci-cd.yml?color=%2341BE4A&style=flat
-        :target: https://github.com/vacanza/python-holidays/actions
-        :alt: CI/CD status
+.. |status| image:: https://img.shields.io/github/actions/workflow/status/vacanza/python-holidays/ci-cd.yml?color=%2341BE4A&style=flat
+    :target: https://github.com/vacanza/python-holidays/actions
+    :alt: CI/CD status
 
-    .. image:: https://img.shields.io/readthedocs/python-holidays?color=%2341BE4A&style=flat
-        :target: https://python-holidays.readthedocs.io/en/latest/?badge=latest
-        :alt: Documentation status
+.. |documentation| image:: https://img.shields.io/readthedocs/python-holidays?color=%2341BE4A&style=flat
+    :target: https://python-holidays.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation status
 
-:Code:
-    .. image:: https://img.shields.io/github/license/vacanza/python-holidays?color=%2341B5BE&style=flat
-        :target: LICENSE
-        :alt: License
+.. |license| image:: https://img.shields.io/github/license/vacanza/python-holidays?color=%2341B5BE&style=flat
+    :target: https://github.com/vacanza/python-holidays/blob/dev/LICENSE
+    :alt: License
 
-    .. image:: https://img.shields.io/pypi/pyversions/holidays?label=python&color=%2341B5BE&style=flat
-        :target: https://pypi.org/project/holidays
-        :alt: Python supported versions
+.. |python versions| image:: https://img.shields.io/pypi/pyversions/holidays?label=python&color=%2341B5BE&style=flat
+    :target: https://pypi.org/project/holidays
+    :alt: Python supported versions
 
-    .. image:: https://img.shields.io/badge/code%20style-black-%252333F93C0?label=style&color=%2341B5BE&style=flat
-        :target: https://github.com/psf/black
-        :alt: Code style
+.. |style| image:: https://img.shields.io/badge/code%20style-black-%252333F93C0?label=style&color=%2341B5BE&style=flat
+    :target: https://github.com/psf/black
+    :alt: Code style
 
-    .. image:: https://img.shields.io/coverallsCoverage/github/vacanza/python-holidays?branch=main&color=%2341B5BE&style=flat
-        :target: https://coveralls.io/r/vacanza/python-holidays
-        :alt: Code coverage
+.. |coverage| image:: https://img.shields.io/coverallsCoverage/github/vacanza/python-holidays?branch=main&color=%2341B5BE&style=flat
+    :target: https://coveralls.io/r/vacanza/python-holidays
+    :alt: Code coverage
 
+.. |stars| image:: https://img.shields.io/github/stars/vacanza/python-holidays?color=%2341BE4A&style=flat
+    :target: https://github.com/vacanza/python-holidays/stargazers
+    :alt: GitHub stars
 
-:GitHub:
-    .. image:: https://img.shields.io/github/stars/vacanza/python-holidays?color=%2341BE4A&style=flat
-        :target: https://github.com/vacanza/python-holidays/stargazers
-        :alt: GitHub stars
+.. |forks| image:: https://img.shields.io/github/forks/vacanza/python-holidays?color=%2341BE4A&style=flat
+    :target: https://github.com/vacanza/python-holidays/forks
+    :alt: GitHub forks
 
-    .. image:: https://img.shields.io/github/forks/vacanza/python-holidays?color=%2341BE4A&style=flat
-        :target: https://github.com/vacanza/python-holidays/forks
-        :alt: GitHub forks
+.. |contributors| image:: https://img.shields.io/github/contributors/vacanza/python-holidays?color=%2341BE4A&style=flat
+    :target: https://github.com/vacanza/python-holidays/graphs/contributors
+    :alt: GitHub contributors
 
-    .. image:: https://img.shields.io/github/contributors/vacanza/python-holidays?color=%2341BE4A&style=flat
-        :target: https://github.com/vacanza/python-holidays/graphs/contributors
-        :alt: GitHub contributors
-
-    .. image:: https://img.shields.io/github/last-commit/vacanza/python-holidays/dev?color=%2341BE4A&style=flat
-        :target: https://github.com/vacanza/python-holidays/commits/dev
-        :alt: GitHub last commit
+.. |last commit| image:: https://img.shields.io/github/last-commit/vacanza/python-holidays/dev?color=%2341BE4A&style=flat
+    :target: https://github.com/vacanza/python-holidays/commits/dev
+    :alt: GitHub last commit
 
++--------+------------------------------------------------+
+| PyPI   | |downloads| |version| |release date|           |
++--------+------------------------------------------------+
+| CI/CD  | |status| |documentation|                       |  
++--------+------------------------------------------------+
+| Code   | |license| |python versions| |style| |coverage| |
++--------+------------------------------------------------+
+| GitHub | |stars| |forks| |contributors| |last commit|   |
++--------+------------------------------------------------+
 
 Install
 -------
@@ -938,15 +942,15 @@ Contributions
 
 .. _Issues: https://github.com/vacanza/python-holidays/issues
 .. _pull requests: https://github.com/vacanza/python-holidays/pulls
-.. _here: CONTRIBUTING.rst
+.. _here: https://github.com/vacanza/python-holidays/blob/dev/CONTRIBUTING.rst
 
 Issues_ and `pull requests`_ are always welcome.  Please see
 `here`_ for more information.
 
 License
 -------
 
-.. __: LICENSE
+.. __: https://github.com/vacanza/python-holidays/blob/dev/LICENSE
 
 Code and documentation are available according to the MIT License
 (see LICENSE__).