Add broken links check in docs (#333)

Author: chtruong814

.github/workflows/build-docs.yml

@@ -0,0 +1,26 @@
+# Copyright (c) 2025, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Build docs
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, labeled, unlabeled]
+  workflow_call:
+
+jobs:
+  build-docs:
+    uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/[email protected]
+    with:
+      docs-directory: docs/source

docs/source/conf.py

@@ -103,3 +103,9 @@
     ],
 }
 html_extra_path = ["project.json", "versions1.json"]
+
+# Github links are now getting rate limited from the Github Actions
+linkcheck_ignore = [
+    ".*github\\.com.*",
+    ".*githubusercontent\\.com.*",
+]

docs/source/guides/management.md

@@ -135,4 +135,4 @@ nemorun experiment cancel experiment_with_scripts_1720556256 0
 
 This information is specific to each experiment on how to manage it.
 
-See [this notebook](../../../examples/hello-world/hello_experiments.ipynb) for more details and a playable experience.
+See [this notebook](https://github.com/NVIDIA-NeMo/Run/blob/main/examples/hello-world/hello_experiments.ipynb) for more details and a playable experience.

docs/source/index.rst

@@ -8,9 +8,9 @@ NeMo-Run Documentation
 
 NeMo-Run is a powerful tool designed to streamline the configuration, execution and management of Machine Learning experiments across various computing environments. NeMo Run has three core responsibilities:
 
-1. `Configuration <./guides/configuration.html>`_
-2. `Execution <./guides/execution.html>`_
-3. `Management <./guides/management.html>`_
+1. :doc:`Configuration <guides/configuration>`
+2. :doc:`Execution <guides/execution>`
+3. :doc:`Management <guides/management>`
 
 Please click into each link to learn more.
 This is also the typical order Nemo Run users will follow to setup and launch experiments.
@@ -61,6 +61,6 @@ The ``hello_world`` tutorial series provides a comprehensive introduction to NeM
 
 You can find the tutorial series below:
 
-1. `Part 1: Hello World <../../../examples/hello-world/hello_world.ipynb>`_
-2. `Part 2: Hello Experiments <../../../examples/hello-world/hello_experiments.ipynb>`_
-3. `Part 3: Hello Scripts <../../../examples/hello-world/hello_scripts.py>`_
+1. `Part 1: Hello World <https://github.com/NVIDIA-NeMo/Run/blob/main/examples/hello-world/hello_world.ipynb>`_
+2. `Part 2: Hello Experiments <https://github.com/NVIDIA-NeMo/Run/blob/main/examples/hello-world/hello_experiments.ipynb>`_
+3. `Part 3: Hello Scripts <https://github.com/NVIDIA-NeMo/Run/blob/main/examples/hello-world/hello_scripts.py>`_