ci: restrict build docs on PR (#18923)

* ci: restrict build docs on PR * linkcheck_timeout
Lightning-AI · Nov 2, 2023 · 1e68c50 · 1e68c50
1 parent 5f6669f
commit 1e68c50
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 1 deletion.
diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
@@ -14,7 +14,12 @@ on:
       - "docs/**"
       - "_notebooks"
       - "requirements/**"
-      - "src/**"
+      - "src/lightning/app/**"
+      - "src/lightning_app/*"
+      - "src/lightning/fabric/**"
+      - "src/lightning_fabric/*"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "setup.py"
       - "pyproject.toml" # includes metadata used in the package creation
       - "!*.md"

diff --git a/docs/source-app/conf.py b/docs/source-app/conf.py
@@ -444,5 +444,8 @@ def find_source():
 # skip false positive linkcheck errors from anchors
 linkcheck_anchors = False
 
+# A timeout value, in seconds, for the linkcheck builder.
+linkcheck_timeout = 10
+
 # ignore all links in any CHANGELOG file
 linkcheck_exclude_documents = [r"^(.*\/)*CHANGELOG.*$"]
diff --git a/docs/source-fabric/conf.py b/docs/source-fabric/conf.py
@@ -408,5 +408,8 @@ def find_source():
 # skip false positive linkcheck errors from anchors
 linkcheck_anchors = False
 
+# A timeout value, in seconds, for the linkcheck builder.
+linkcheck_timeout = 10
+
 # ignore all links in any CHANGELOG file
 linkcheck_exclude_documents = [r"^(.*\/)*CHANGELOG.*$"]
diff --git a/docs/source-pytorch/conf.py b/docs/source-pytorch/conf.py
@@ -600,6 +600,9 @@ def package_list_from_file(file):
 # skip false positive linkcheck errors from anchors
 linkcheck_anchors = False
 
+# A timeout value, in seconds, for the linkcheck builder.
+linkcheck_timeout = 10
+
 # ignore all links in any CHANGELOG file
 linkcheck_exclude_documents = [r"^(.*\/)*CHANGELOG.*$"]