You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sr...@apache.org on 2023/09/16 14:05:17 UTC
[spark] branch branch-3.3 updated: [SPARK-45127][DOCS] Exclude README.md from document build
This is an automated email from the ASF dual-hosted git repository.
srowen pushed a commit to branch branch-3.3
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.3 by this push:
new 6dcab1fe0f6 [SPARK-45127][DOCS] Exclude README.md from document build
6dcab1fe0f6 is described below
commit 6dcab1fe0f64458d76060e38fad974d6b84c4ff7
Author: panbingkun <pb...@gmail.com>
AuthorDate: Sat Sep 16 09:04:38 2023 -0500
[SPARK-45127][DOCS] Exclude README.md from document build
### What changes were proposed in this pull request?
The pr aims to exclude `README.md` from document build.
### Why are the changes needed?
- Currently, our document `README.html` does not have any CSS style applied to it, as shown below:
https://spark.apache.org/docs/latest/README.html
<img width="1432" alt="image" src="https://github.com/apache/spark/assets/15246973/1dfe5f69-30d9-4ce4-8d82-1bba5e721ccd">
**If we do not intend to display the above page to users, we should remove it during the document build process.**
- As we saw in the project `spark-website`, it has already set the following configuration:
https://github.com/apache/spark-website/blob/642d1fb834817014e1799e73882d53650c1c1662/_config.yml#L7
<img width="720" alt="image" src="https://github.com/apache/spark/assets/15246973/421b7be5-4ece-407e-9d49-8e7487b74a47">
Let's stay consistent.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
- Manually test.
After this pr, the README.html file will no longer be generated
```
(base) panbingkun:~/Developer/spark/spark-community/docs/_site$ls -al README.html
ls: README.html: No such file or directory
```
- Pass GA.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #42883 from panbingkun/SPARK-45127.
Authored-by: panbingkun <pb...@gmail.com>
Signed-off-by: Sean Owen <sr...@gmail.com>
(cherry picked from commit 804f741453fb146b5261084fa3baf26631badb79)
Signed-off-by: Sean Owen <sr...@gmail.com>
---
docs/_config.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/_config.yml b/docs/_config.yml
index 82da6b4ddff..c0f752a6155 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -46,3 +46,5 @@ DOCSEARCH_SCRIPT: |
});
permalink: 404.html
+
+exclude: ['README.md']
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org