From d5b534d18c060e960f049d2756df39d1d046a48c Mon Sep 17 00:00:00 2001 From: panbingkun Date: Fri, 29 Nov 2024 18:56:40 +0800 Subject: [PATCH] [SPARK-50295][DOCS][FOLLOWUP] Document `build-docs` in `docs/README.md` ### What changes were proposed in this pull request? The pr aims to document `dev/spark-test-image-util/docs/build-docs` in `docs/README.md`. ### Why are the changes needed? Add documentation for using script `dev/spark-test-image-util/docs/build-docs`. ### Does this PR introduce _any_ user-facing change? Yes, Spark developers will be able to know the existence of script `dev/spark-test-image-util/docs/build-docs` through documentation `docs/README.md`. ### How was this patch tested? Manually check. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #49013 from panbingkun/SPARK-50295_FOLLOWUP. Lead-authored-by: panbingkun Co-authored-by: panbingkun Signed-off-by: panbingkun --- dev/spark-test-image-util/docs/build-docs | 0 docs/README.md | 13 +++++++++++++ 2 files changed, 13 insertions(+) mode change 100644 => 100755 dev/spark-test-image-util/docs/build-docs diff --git a/dev/spark-test-image-util/docs/build-docs b/dev/spark-test-image-util/docs/build-docs old mode 100644 new mode 100755 diff --git a/docs/README.md b/docs/README.md index 363f1c2076363..1235efe91812b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -126,3 +126,16 @@ To control what API docs get built, you can set any combination of the following * `SKIP_RDOC=1`: Skip the R API docs. * `SKIP_SQLDOC=1`: Skip the SQL API docs. +## Build docs with docker image (Optional) + +As a Spark developer, you can generate all documents locally as follows: + +Note: Before running it, you need to have `docker` installed. + +```sh +$ dev/spark-test-image-util/docs/build-docs +``` + +It will generate all documents on the `container` and `host`. +Especially when there are conflicts between the libraries required by Python development environment +and the libraries required by generating Python docs environment, this is a good choice.