[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 <[email protected]> Co-authored-by: panbingkun <[email protected]> Signed-off-by: panbingkun <[email protected]>
apache · Nov 29, 2024 · d5b534d · d5b534d
1 parent 5476610
commit d5b534d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/dev/spark-test-image-util/docs/build-docs b/dev/spark-test-image-util/docs/build-docs
diff --git 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.