Docs: list all metrics (#1077)

* list all metrics * freeze sphinx 4.x
Lightning-AI · Jun 7, 2022 · 35fcc88 · 35fcc88
1 parent 9e26cae
commit 35fcc88
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -128,6 +128,7 @@ Or directly from conda
    :caption: User Guide
 
    pages/quickstart
+   pages/all-metrics
    pages/overview
    pages/implement
    pages/lightning

diff --git a/docs/source/metrics.rst → docs/source/pages/all-metrics.rst b/docs/source/metrics.rst → docs/source/pages/all-metrics.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 All TorchMetrics
 ================
 

diff --git a/docs/source/pages/overview.rst b/docs/source/pages/overview.rst
@@ -3,9 +3,9 @@
     import torch
     from pytorch_lightning.core.lightning import LightningModule
 
-########
-Overview
-########
+##################
+Structure Overview
+##################
 
 TorchMetrics is a Metrics API created for easy metric development and usage in
 PyTorch and PyTorch Lightning. It is rigorously tested for all edge cases and includes a growing list of

diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,4 +1,4 @@
-sphinx>=4.0
+sphinx>=4.0, <5.0
 myst-parser
 nbsphinx>=0.8
 pandoc>=1.0