Repository: Lightning-AI/pytorch-lightning

Issue:
Links between Lightning docs are not linked properly
## 📚 Documentation

https://pytorch-lightning.readthedocs.io/en/latest/trainer.html#profiler

The link to profiler.html is not properly linked.
These links are happening too (found out so far).
- link to multi gpu docs
- link to slurm docs
- link to lr_finder docs
- link to logger docs

This is not happening on the stable 0.9.0 docs.
I couldn't find what PR caused this or something caused this.

Currently, they are linked like 
```py
`Title <title.rst>`_
```
Using `:ref:` fixed this for now. But, I'm not sure this is a proper way to fix.


Discussion:
@ydcjeff yes using ref on the anchor is correct. could you try to fix it? 
@awaelchli okay, I will try it

Resolving patch:
diff --git a/pytorch_lightning/callbacks/progress.py b/pytorch_lightning/callbacks/progress.py
--- a/pytorch_lightning/callbacks/progress.py
+++ b/pytorch_lightning/callbacks/progress.py
@@ -138,7 +138,7 @@ def enable(self):
         """
         You should provide a way to enable the progress bar.
         The :class:`~pytorch_lightning.trainer.trainer.Trainer` will call this in e.g. pre-training
-        routines like the `learning rate finder <lr_finder.rst>`_ to temporarily enable and
+        routines like the :ref:`learning rate finder <lr_finder>` to temporarily enable and
         disable the main progress bar.
         """
         raise NotImplementedError
diff --git a/pytorch_lightning/core/lightning.py b/pytorch_lightning/core/lightning.py
--- a/pytorch_lightning/core/lightning.py
+++ b/pytorch_lightning/core/lightning.py
@@ -335,7 +335,7 @@ def training_step_end(self, training_step_outputs):
                 return result
 
         See Also:
-            See the :ref:`multi-gpu-training` guide for more details.
+            See the :ref:`multi_gpu` guide for more details.
         """
 
     def training_epoch_end(
@@ -531,7 +531,7 @@ def validation_epoch_end(self, output_results):
                 return result
 
         See Also:
-            See the :ref:`multi-gpu-training` guide for more details.
+            See the :ref:`multi_gpu` guide for more details.
         """
 
     def validation_end(self, outputs):
@@ -732,7 +732,7 @@ def test_epoch_end(self, output_results):
                 return result
 
         See Also:
-            See the :ref:`multi-gpu-training` guide for more details.
+            See the :ref:`multi_gpu` guide for more details.
         """
 
     def test_end(self, outputs):
diff --git a/pytorch_lightning/trainer/__init__.py b/pytorch_lightning/trainer/__init__.py
--- a/pytorch_lightning/trainer/__init__.py
+++ b/pytorch_lightning/trainer/__init__.py
@@ -261,7 +261,7 @@ def forward(self, x):
     trainer = Trainer(auto_lr_find='my_lr_arg')
 
 .. note::
-    See the `learning rate finder guide <lr_finder.rst>`_
+    See the :ref:`learning rate finder guide <lr_finder>`.
 
 benchmark
 ^^^^^^^^^
@@ -402,8 +402,8 @@ def on_train_end(self, trainer, pl_module):
 .. note:: this option does not apply to TPU. TPUs use ```ddp``` by default (over each core)
 
 See Also:
-    - `Multi-GPU training guide <multi_gpu.rst>`_
-    - `Multi-node (SLURM) guide <slurm.rst>`_
+    - :ref:`Multi-GPU training guide <multi_gpu>`.
+    - :ref:`Multi-node (SLURM) guide <slurm>`.
 
 early_stop_callback
 ^^^^^^^^^^^^^^^^^^^
@@ -499,7 +499,7 @@ def on_train_end(self, trainer, pl_module):
     trainer = Trainer(gpus=[1, 4], num_nodes=4)
 
 See Also:
-    - `Multi-GPU training guide <multi_gpu.rst>`_
+    - :ref:`Multi-GPU training guide <multi_gpu>`.
 
 gradient_clip_val
 ^^^^^^^^^^^^^^^^^
@@ -584,7 +584,7 @@ def on_train_end(self, trainer, pl_module):
 logger
 ^^^^^^
 
-`Logger <loggers.rst>`_ (or iterable collection of loggers) for experiment tracking.
+:ref:`Logger <loggers>` (or iterable collection of loggers) for experiment tracking.
 
 .. testcode::
 
@@ -820,7 +820,7 @@ def on_train_end(self, trainer, pl_module):
 ^^^^^^^^
 To profile individual steps during training and assist in identifying bottlenecks.
 
-See the `profiler documentation <profiler.rst>`_. for more details.
+See the :ref:`profiler documentation <profiler>`. for more details.
 
 .. testcode::
 


Test patch:
diff --git a/docs/source/test_set.rst b/docs/source/test_set.rst
--- a/docs/source/test_set.rst
+++ b/docs/source/test_set.rst
@@ -1,4 +1,4 @@
-.. _test-set:
+.. _test_set:
 
 Test set
 ========