This is an automated email from the ASF dual-hosted git repository.
yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 81948bb61d5f [SPARK-49174][BUILD][DOCS] Exclude the dir `docs/util`
from `_site`
81948bb61d5f is described below
commit 81948bb61d5f3cbf193b0ba8bddb4afdcb1ec126
Author: panbingkun <[email protected]>
AuthorDate: Fri Aug 9 17:39:32 2024 +0800
[SPARK-49174][BUILD][DOCS] Exclude the dir `docs/util` from `_site`
### What changes were proposed in this pull request?
The pr aims to `exclude` the dir `docs/util` from `_site`.
eg: https://spark.apache.org/docs/4.0.0-preview1/util/build-error-docs.py
### Why are the changes needed?
Eliminate `unnecessary` files in the `site`.
ref: https://jekyllrb.com/docs/configuration/options/
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Manually check.
- Before
https://github.com/panbingkun/spark/actions/runs/10311043869/artifacts/1793190911
<img width="515" alt="image"
src="https://github.com/user-attachments/assets/788e5fe2-808c-4feb-bf06-8f1bfc0d13c0";>
- After
https://github.com/panbingkun/spark/actions/runs/10315064902/artifacts/1793887413
<img width="317" alt="image"
src="https://github.com/user-attachments/assets/27caee0b-6b95-49bb-8b9a-c35e45e69bd1";>
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #47678 from panbingkun/SPARK-49174.
Authored-by: panbingkun <[email protected]>
Signed-off-by: Kent Yao <[email protected]>
---
docs/{util => _plugins}/build-error-docs.py | 0
docs/_plugins/build_api_docs.rb | 2 +-
docs/sql-error-conditions.md | 2 +-
3 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/util/build-error-docs.py b/docs/_plugins/build-error-docs.py
similarity index 100%
rename from docs/util/build-error-docs.py
rename to docs/_plugins/build-error-docs.py
diff --git a/docs/_plugins/build_api_docs.rb b/docs/_plugins/build_api_docs.rb
index bdb8d028f22a..80863b4b56b1 100644
--- a/docs/_plugins/build_api_docs.rb
+++ b/docs/_plugins/build_api_docs.rb
@@ -199,7 +199,7 @@ def build_error_docs
raise("Missing python3 in your path, stopping error doc generation")
end
- system("python3 '#{SPARK_PROJECT_ROOT}/docs/util/build-error-docs.py'") \
+ system("python3 '#{SPARK_PROJECT_ROOT}/docs/_plugins/build-error-docs.py'") \
|| raise("Error doc generation failed")
end
diff --git a/docs/sql-error-conditions.md b/docs/sql-error-conditions.md
index 0c1953ea8f46..590c14b9912d 100644
--- a/docs/sql-error-conditions.md
+++ b/docs/sql-error-conditions.md
@@ -26,7 +26,7 @@ Keep this documentation focused on error states (e.g.
`58002`) and conditions (e
for when they encounter an error.
To update this information, edit `error-conditions.json`. The table below will
be automatically
-derived from that file via `docs/util/build-error-docs.py`.
+derived from that file via `docs/_plugins/build-error-docs.py`.
Also note that this is a Jekyll comment and not an HTML comment so that this
comment does not show
up in the generated HTML to end users. :-)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
