Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix build error, avoid testdata scan infinite loop. #421

Merged
merged 3 commits into from
Dec 3, 2024
Merged

docs: fix build error, avoid testdata scan infinite loop. #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d04d639
docs: ignore testdata when scanning docs.
klihub Dec 2, 2024
1cb6586
docs: use recent golang when building docs.
klihub Dec 2, 2024
9920b82
docs: bump sphinx toolchain to latest 7.x.
klihub Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
FROM sphinxdoc/sphinx:5.3.0
FROM sphinxdoc/sphinx:7.4.7

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

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading