Merge branch 'main' into dependabot-pip-_requirements-torchmetrics-gt…

…e-0.7-and-lt-1.1
Lightning-AI · Aug 14, 2023 · 41361f4 · 41361f4
2 parents da114bb + 89b94ba
commit 41361f4
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 22 deletions.
diff --git a/.github/workflows/ci_checks.yml b/.github/workflows/ci_checks.yml
@@ -15,4 +15,4 @@ concurrency:
 jobs:
 
   check-schema:
-    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.8.0
+    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.9.0
diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -99,13 +99,7 @@ jobs:
 
       - name: Make Documentation
         working-directory: ./_docs
-        run: make html --debug SPHINXOPTS="-W --keep-going"
-
-      - name: Check External Links (Optional)
-        working-directory: ./_docs
-        run: make --jobs $(nproc) linkcheck
-        # ToDO: comment on PR if any link failed
-        continue-on-error: true
+        run: make html --jobs $(nproc) --debug SPHINXOPTS="-W --keep-going" linkcheck
 
       - name: Upload built docs
         uses: actions/upload-artifact@v3

diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml
@@ -47,7 +47,7 @@ jobs:
         run: make html --jobs $(nproc)
 
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.4.2
+        uses: JamesIves/github-pages-deploy-action@v4.4.3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages # The branch the action should deploy to.

diff --git a/_docs/source/conf.py b/_docs/source/conf.py
@@ -51,7 +51,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 
-needs_sphinx = "6.2"
+needs_sphinx = "5.3"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -224,8 +224,17 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-# intersphinx_mapping = {
-#     "python": ("https://docs.python.org/3", None),
-#     "torch": ("https://pytorch.org/docs/stable/", None),
-#     "numpy": ("https://docs.scipy.org/doc/numpy/", None),
-# }
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "torch": ("https://pytorch.org/docs/stable/", None),
+    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+}
+
+# skip false positive linkcheck errors from anchors
+linkcheck_anchors = False
+
+# ignore all links in any CHANGELOG file
+linkcheck_exclude_documents = []
+
+# ignore the following relative links (false positive errors during linkcheck)
+linkcheck_ignore = []
diff --git a/_requirements/default.txt b/_requirements/default.txt
@@ -1,4 +1,4 @@
-setuptools==67.8.0
+setuptools==68.0.0
 matplotlib>=3.0.0, <3.8.0
 ipython[notebook]>=8.0.0, <8.15.0
 urllib3  # for ipython

diff --git a/_requirements/docs.txt b/_requirements/docs.txt
@@ -1,9 +1,9 @@
-sphinx >=6.0, <7.0
-myst-parser >=2.0.0
-nbsphinx >=0.8
-pandoc >=1.0
-#docutils>=0.16
-sphinx-paramlinks >=0.4.0
+sphinx >5.0, <6.0
+myst-parser >=0.18.1, <3.0.0
+nbsphinx >=0.8.5, <=0.8.9
+pandoc >=1.0, <=2.3
+#docutils >=0.16
+sphinx-paramlinks >=0.5.1, <=0.5.4
 ipython[notebook] >=8.0.0, <8.2.0
 
 pt-lightning-sphinx-theme @ https://github.com/Lightning-AI/lightning_sphinx_theme/archive/master.zip