uros-b commented on code in PR #57010: URL: https://github.com/apache/spark/pull/57010#discussion_r3535271784
########## docs/README.md: ########## @@ -120,8 +120,11 @@ using [roxygen2](https://cran.r-project.org/web/packages/roxygen2/index.html) an using [MkDocs](https://www.mkdocs.org/). To control what API docs get built, you can set any combination of the following shell variables before you run `bundle exec jekyll build`: -* `SKIP_API=1`: Skip building all the API docs. -* `SKIP_SCALADOC=1`: Skip the Scala and Java API docs. +* `SKIP_ERRORDOC=1`: Skip building the unified error documentation. +* `SKIP_SPARK_BUILD=1`: Skip building Spark. A working Spark build is required for the docs (except the error docs) to build correctly, so set this only if you know you've already built Spark. +* `SKIP_API=1`: Skip building all the API docs. This is basically the same as setting all of the skip flags below. +* `SKIP_SCALADOC=1`: Skip the Scala and Java API docs, which includes building the Unidoc. +* `SKIP_UNIDOC=1`: Skip building the Unidoc. Review Comment: Doc-wording nit: the SKIP_UNIDOC=1 entry ("Skip building the Unidoc") omits that the Scala/Java copy step (copy_and_update_scala_docs/copy_and_update_java_docs from target/scala-2.13/unidoc and target/javaunidoc) still runs, so the build fails there if no pre-built unidoc output exists. SKIP_SPARK_BUILD=1 carries the analogous "only set this if you've already built" caveat; SKIP_UNIDOC should too (use SKIP_SCALADOC=1 to skip the copy as well). -- 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]
