nchammas commented on a change in pull request #26719: [SPARK-30084] Document how to trigger Jekyll build on Python API doc changes URL: https://github.com/apache/spark/pull/26719#discussion_r352293030
########## File path: docs/README.md ########## @@ -102,3 +102,17 @@ using [MkDocs](https://www.mkdocs.org/). NOTE: To skip the step of building and copying over the Scala, Java, Python, R and SQL API docs, run `SKIP_API=1 jekyll build`. In addition, `SKIP_SCALADOC=1`, `SKIP_PYTHONDOC=1`, `SKIP_RDOC=1` and `SKIP_SQLDOC=1` can be used to skip a single step of the corresponding language. `SKIP_SCALADOC` indicates skipping both the Scala and Java docs. + +### Automatically Rebuilding API Docs + +`jekyll serve --watch` will only watch what's in `docs/`, and it [won't follow symlinks](https://github.com/jekyll/jekyll/issues/233). That means it won't monitor your API docs. Review comment: I tried yesterday to get Jekyll to pick up Python API doc changes via symlink, since Jekyll only monitors files in the directory it's running in, and the Python source lives outside of `docs/`. I couldn't get it to work. I'll try again. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
