From 83379470db183fa0f15bd50863195c63c7d74850 Mon Sep 17 00:00:00 2001 From: Jirka Borovec <6035284+Borda@users.noreply.github.com> Date: Mon, 14 Aug 2023 21:52:45 +0200 Subject: [PATCH 1/4] ci/docs: freeze versions & linkcheck (#266) --- .github/workflows/ci_docs.yml | 8 +------- _docs/source/conf.py | 21 +++++++++++++++------ _requirements/docs.txt | 12 ++++++------ 3 files changed, 22 insertions(+), 19 deletions(-) diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml index 7902d986d..ac8acf7cd 100644 --- 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/_docs/source/conf.py b/_docs/source/conf.py index 6558509b1..d7f99348b 100644 --- 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/docs.txt b/_requirements/docs.txt index 7adb81b32..fa774a632 100644 --- 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 From 8d5658cae405e2f38c4ce7ea5c419552bb51dee0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 14 Aug 2023 20:02:32 +0000 Subject: [PATCH 2/4] Bump setuptools from 67.8.0 to 68.0.0 in /_requirements (#257) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- _requirements/default.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_requirements/default.txt b/_requirements/default.txt index 913834f62..e022f2018 100644 --- 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 From c06b785a3ecb6528fe3289e904a1e144e7622f3a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 14 Aug 2023 20:18:02 +0000 Subject: [PATCH 3/4] Bump JamesIves/github-pages-deploy-action from 4.4.2 to 4.4.3 (#265) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/docs-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 0547d8b80..fb4eefe9a 100644 --- 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. From 89b94ba68ab66630bb90c02ff92cb656d3ea75f0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 14 Aug 2023 20:35:36 +0000 Subject: [PATCH 4/4] Bump Lightning-AI/utilities from 0.8.0 to 0.9.0 (#258) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci_checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_checks.yml b/.github/workflows/ci_checks.yml index 408da9302..fea6be290 100644 --- 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