Fix banner, add badges and documentation link. (#6)

BlueBrain · Jul 17, 2024 · cd45fc5 · cd45fc5
1 parent 6ce8797
commit cd45fc5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git 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/l/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
@@ -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 = [