From d04d639463e412e4f46bab2bb007acb9cc22e79d Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Mon, 2 Dec 2024 09:48:10 +0200 Subject: [PATCH 1/3] docs: ignore testdata when scanning docs. Don't fall into an infinite loop while scanning sample sysfs data for tests. Ignore such data altogether instead. Signed-off-by: Krisztian Litkey --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index bfcbf2de6..4a8565c6e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -127,7 +127,7 @@ def gomod_versions(modules): # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['build', 'build-aux', '_build', '.github', '_work', 'generate', 'README.md', 'TODO.md', 'SECURITY.md', 'CODE-OF-CONDUCT.md', 'docs/releases', 'test/self-hosted-runner/README.md', 'test/e2e/README.md', 'docs/resource-policy/releases', 'docs/resource-policy/README.md','test/statistics-analysis/README.md', 'deployment/helm/*/*.md'] +exclude_patterns = ['build', 'build-aux', '_build', '.github', '_work', 'generate', 'README.md', 'TODO.md', 'SECURITY.md', 'CODE-OF-CONDUCT.md', 'docs/releases', 'test/self-hosted-runner/README.md', 'test/e2e/README.md', 'docs/resource-policy/releases', 'docs/resource-policy/README.md','test/statistics-analysis/README.md', 'deployment/helm/*/*.md', '**/testdata'] # -- Options for HTML output ------------------------------------------------- From 1cb6586d56dfe92de561eb244bc7eac9ff0541f8 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Mon, 2 Dec 2024 09:54:57 +0200 Subject: [PATCH 2/3] docs: use recent golang when building docs. Bump golang toolchain version to avoid docs build failures with go.mod's stating go version with patch-level detail. Signed-off-by: Krisztian Litkey --- docs/Dockerfile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index bc702fdcd..332fb2280 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,10 +1,12 @@ FROM sphinxdoc/sphinx:5.3.0 +ARG GO_VERSION=1.23.3 + RUN apt-get update && apt-get install -y wget git # Note: Any golang version that can 'go list -m -f {{.Variable}}' is fine... -RUN wget https://go.dev/dl/go1.20.4.linux-amd64.tar.gz && \ - tar -C /usr/local -xzf go1.20.4.linux-amd64.tar.gz +RUN wget https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz && \ + tar -C /usr/local -xzf go${GO_VERSION}.linux-amd64.tar.gz ENV PATH=$PATH:/usr/local/go/bin From 9920b823980a86fa1a1d03eabbfafed7dbdda776 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Mon, 2 Dec 2024 09:55:52 +0200 Subject: [PATCH 3/3] docs: bump sphinx toolchain to latest 7.x. Update sphinx toolchain to 7.4.7, the latest version which can still use sphinx_rtd_theme 2.0.0, one with support for 'display_version'. Signed-off-by: Krisztian Litkey --- docs/Dockerfile | 2 +- docs/requirements.txt | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 332fb2280..9f069a0b0 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,4 +1,4 @@ -FROM sphinxdoc/sphinx:5.3.0 +FROM sphinxdoc/sphinx:7.4.7 ARG GO_VERSION=1.23.3 diff --git a/docs/requirements.txt b/docs/requirements.txt index a9664f407..ac090a8cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ -sphinx==5.3.0 -sphinx_rtd_theme==1.2.2 -myst-parser==0.19.2 +sphinx==7.4.7 +sphinx_rtd_theme==2.0.0 +myst-parser==4.0.0 sphinx-markdown-tables==0.0.17 -Pygments==2.15.0 +Pygments==2.17.0