From c74791e55ea3a0c3bd389d47f0acb48ac867b5ba Mon Sep 17 00:00:00 2001 From: Matthias Wolf Date: Fri, 12 Jul 2024 11:21:20 +0200 Subject: [PATCH 1/2] Fix banner, add badges and documentation link. --- README.rst | 11 ++++++++++- pyproject.toml | 1 + 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ca38da8..9c63d3e 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,8 @@ -.. image:: doc/source/_static/banner.jpg +.. image:: docs/source/_static/banner.jpg :alt: A nice banner for functionalizer +|license| |docs| + Functionalizer ============== @@ -57,3 +59,10 @@ from the Swiss government's ETH Board of the Swiss Federal Institutes of Technol Copyright (c) 2017-2024 Blue Brain Project/EPFL .. _SONATA extension: https://sonata-extension.readthedocs.io + +.. |license| image:: https://img.shields.io/pypi/f/functionalizer + :target: https://github.com/BlueBrain/functionalizer/blob/master/LICENSE.txt + +.. |docs| image:: https://readthedocs.org/projects/functionalizer/badge/?version=latest + :target: https://functionalizer.readthedocs.io/ + :alt: documentation status diff --git a/pyproject.toml b/pyproject.toml index 4816d83..9f6d047 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ build-backend = "scikit_build_core.build" name = "functionalizer" dynamic = ["version"] description = "A PySpark implementation of the Blue Brain Project Functionalizer" +documentation = "https://functionalizer.readthedocs.io/" license = {"file" = "LICENSE.txt"} authors = [{"name" = "BlueBrain HPC", "email" = "bbp-ou-hpc@epfl.ch"}] maintainers = [ From 084a8b07a679c70df9826b68ee6b42e8e6de4808 Mon Sep 17 00:00:00 2001 From: Matthias Wolf Date: Fri, 12 Jul 2024 11:24:52 +0200 Subject: [PATCH 2/2] Fix license badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9c63d3e..894c9d7 100644 --- a/README.rst +++ b/README.rst @@ -60,7 +60,7 @@ Copyright (c) 2017-2024 Blue Brain Project/EPFL .. _SONATA extension: https://sonata-extension.readthedocs.io -.. |license| image:: https://img.shields.io/pypi/f/functionalizer +.. |license| image:: https://img.shields.io/pypi/l/functionalizer :target: https://github.com/BlueBrain/functionalizer/blob/master/LICENSE.txt .. |docs| image:: https://readthedocs.org/projects/functionalizer/badge/?version=latest