HyukjinKwon commented on code in PR #49013: URL: https://github.com/apache/spark/pull/49013#discussion_r1863064378
########## docs/README.md: ########## @@ -126,3 +126,15 @@ 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: + +```sh +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. +Please refer to [SPARK-50295](https://issues.apache.org/jira/browse/SPARK-50295) for details. Review Comment: I think no need to link the JIRA here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
