diff --git a/docs/source/index.rst b/docs/source/index.rst index 6c020410f77..db7c7ae3d2b 100644 --- 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 b/docs/source/pages/all-metrics.rst similarity index 84% rename from docs/source/metrics.rst rename to docs/source/pages/all-metrics.rst index b35d3ca315b..38cc58cc4fd 100644 --- a/docs/source/metrics.rst +++ b/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 index 25c47a42e21..80809b37c7c 100644 --- 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 index eb521689b83..5fec38c6adc 100644 --- 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