Only run the docs link check on the container (NVIDIA-NeMo#13068)

* Only run docs link check if docs changed

Signed-off-by: Charlie Truong <chtruong@nvidia.com>

* Modify docs readme to trigger link check

Signed-off-by: Charlie Truong <chtruong@nvidia.com>

---------

Signed-off-by: Charlie Truong <chtruong@nvidia.com>

Author: chtruong814

.github/workflows/gh-docs.yml

@@ -44,17 +44,35 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: step-security/changed-files@v45.0.1
+        with:
+          files: docs/**
+          files_separator: ","
+          separator: " "
+
       - name: Set up Python ${{ env.PYTHON_VERSION }}
+        if: steps.changed-files.outputs.any_changed == 'true'
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
+
       - name: Install Sphinx dependencies
+        if: steps.changed-files.outputs.any_changed == 'true'
         run: python3 -m pip install -r requirements/requirements_docs.txt
+
       - name: Linkcheck docs build
+        if: steps.changed-files.outputs.any_changed == 'true'
         run: make -C docs linkcheck || true
+
       - name: Eliminate false positives
+        if: steps.changed-files.outputs.any_changed == 'true'
         run: ./docs/check_for_broken_links.sh
+
       - name: Upload linkcheck output
+        if: steps.changed-files.outputs.any_changed == 'true'
         uses: actions/upload-artifact@v4
         with:
           name: linkcheck-artifact

docs/README.md

@@ -55,8 +55,8 @@ Instead of adding those to the `docs/false_positives.json` file, it would be bes
 reference using a [:ref:](https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref).
 
 For example, instead of writing `Modules <../api.html#modules>` to link to the modules section of
-a `api.rst` file, write it as ``:ref:`Modules <asr-api-modules>` ``. And in the `api.rst` file,
-add this label before the section being linked to:
+a `api.rst` file, write it as ``:ref:`Modules <asr-api-modules>` ``. And in the `api.rst` file, add
+this label before the section being linked to:
 
 ```
 .. _asr-api-modules: