update Read the Docs configuration, enhance README badges

Author: theo-barfoot

.readthedocs.yaml

@@ -14,7 +14,7 @@ build:
 sphinx:
   configuration: docs/source/conf.py
   builder: html
-  fail_on_warning: true
+  fail_on_warning: false
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
@@ -29,4 +29,3 @@ python:
       path: .
       extra_requirements:
         - docs
-    - requirements: docs/requirements.txt

README.md

@@ -1,6 +1,30 @@
 # torchsparsegradutils: Sparsity-preserving gradient utility tools for PyTorch
 
-[![Python tests](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml) [![License](https://img.shields.io/github/license/cai4cai/torchsparsegradutils)](https://github.com/cai4cai/torchsparsegradutils?tab=Apache-2.0-1-ov-file#readme) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+<!-- Badges -->
+<p align="left">
+
+<!-- Release / Distribution -->
+<a href="https://pypi.org/project/torchsparsegradutils/"><img alt="PyPI" src="https://img.shields.io/pypi/v/torchsparsegradutils.svg"></a>
+<a href="https://pypi.org/project/torchsparsegradutils/"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/torchsparsegradutils.svg"></a>
+<a href="https://pypi.org/project/torchsparsegradutils/"><img alt="Downloads" src="https://img.shields.io/pypi/dm/torchsparsegradutils.svg"></a>
+
+<!-- PyTorch Support -->
+<img alt="PyTorch 2.5+" src="https://img.shields.io/badge/PyTorch-2.5%2B-ee4c2c?logo=pytorch">
+<img alt="Tested 2.5 / 2.8 / nightly" src="https://img.shields.io/badge/Tested-2.5%20|%202.8%20|%20nightly-ee4c2c?logo=pytorch">
+
+<!-- CI / Quality -->
+<a href="https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml"><img alt="Build" src="https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg"></a>
+<a href="https://readthedocs.org/projects/torchsparsegradutils"><img alt="Docs" src="https://readthedocs.org/projects/torchsparsegradutils/badge/?version=latest"></a>
+<a href="https://github.com/psf/black"><img alt="Code Style: Black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+<a href="LICENSE"><img alt="License" src="https://img.shields.io/github/license/cai4cai/torchsparsegradutils"></a>
+
+<!-- Optional future badges (uncomment when available) -->
+<!-- <a href="https://codecov.io/gh/cai4cai/torchsparsegradutils"><img alt="Coverage" src="https://codecov.io/gh/cai4cai/torchsparsegradutils/branch/main/graph/badge.svg"></a> -->
+<!-- <a href="https://pepy.tech/project/torchsparsegradutils"><img alt="Downloads" src="https://static.pepy.tech/badge/torchsparsegradutils"></a> -->
+
+</p>
+
+---
 
 A comprehensive collection of utility functions to work with PyTorch sparse tensors, ensuring memory efficiency and supporting various sparsity-preserving tensor operations with automatic differentiation. This package addresses fundamental gaps in PyTorch's sparse tensor ecosystem, providing essential operations that preserve sparsity in gradients during backpropagation.
 

docs/requirements.txt

@@ -43,6 +43,8 @@ def readme():
             "sphinx-autobuild>=2021.3.14",
             "matplotlib>=3.5.0",
             "sphinx-autodoc-typehints>=1.24.0",
+            "sphinxcontrib-bibtex>=2.5.0",
+            "sphinx-gallery>=0.13.0",
         ],
     },
     zip_safe=False,