Docs: enable nitpicky mode and fix broken links (#1300)

* Docs: enable nitpicky mode

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

* Use intersphinx

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

* Ruff

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

* Fix or ignore remaining errors

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

* Fix or ignore remaining errors

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

---------

Signed-off-by: Adam J. Stewart <ajstewart426@gmail.com>

Author: adamjstewart

docs/conf.py

@@ -46,12 +46,21 @@ def get_version():
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.coverage",
+    "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx.ext.mathjax",
     "autodocsumm",
 ]
 
+# Warn about all references where the target cannot be found.
+nitpicky = True
+nitpick_ignore = [
+    # Undocumented classes
+    ("py:class", "torch.FloatTensor"),
+    ("py:class", "torch.LongTensor"),
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -109,6 +118,12 @@ def get_version():
 autoclass_content = "both"
 autodoc_typehints = "description"
 
+# sphinx.ext.intersphinx
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "torch": ("https://docs.pytorch.org/docs/stable/", None),
+}
+
 # --- Work around to make autoclass signatures not (*args, **kwargs) ----------
 
 

segmentation_models_pytorch/losses/tversky.py

@@ -31,8 +31,7 @@ class TverskyLoss(DiceLoss):
             multilabel modes. Weights do not need to be normalized.
 
     Return:
-        loss: torch.Tensor
-
+        torch.Tensor: loss
     """
 
     def __init__(