9dec67717b
### What changes were proposed in this pull request? This PR proposes to `include` `_images` and `_sources` directories, generated from Sphinx, in Jekyll build. **For `_images` directory,** After SPARK-31851, now we add some images to use within the pages built by Sphinx. It copies and images into `_images` directory. Later, when Jekyll builds, the underscore directories are ignored by default which ends up with missing image in the main doc. Before:  After:  **For `_sources` directory,** Please refer [here](https://github.com/sphinx-contrib/sphinx-pretty-searchresults#source-links) and [here](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_copy_source). They are generated by default and used by default in the documentations by Sphinx, and we should better include them. ### Why are the changes needed? To show the images correctly in PySpark documentation. ### Does this PR introduce _any_ user-facing change? No, only in unreleased branches. ### How was this patch tested? Manually tested via: ```bash SKIP_SCALADOC=1 SKIP_RDOC=1 SKIP_SQLDOC=1 jekyll serve --watch ``` Closes #29402 from HyukjinKwon/SPARK-32584. Authored-by: HyukjinKwon <gurwls223@apache.org> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
29 lines
673 B
YAML
29 lines
673 B
YAML
highlighter: rouge
|
|
markdown: kramdown
|
|
gems:
|
|
- jekyll-redirect-from
|
|
|
|
# For some reason kramdown seems to behave differently on different
|
|
# OS/packages wrt encoding. So we hard code this config.
|
|
kramdown:
|
|
entity_output: numeric
|
|
|
|
plugins:
|
|
- jekyll-redirect-from
|
|
|
|
include:
|
|
- _static
|
|
- _modules
|
|
- _images
|
|
- _sources
|
|
|
|
# These allow the documentation to be updated with newer releases
|
|
# of Spark, Scala, and Mesos.
|
|
SPARK_VERSION: 3.1.0-SNAPSHOT
|
|
SPARK_VERSION_SHORT: 3.1.0
|
|
SCALA_BINARY_VERSION: "2.12"
|
|
SCALA_VERSION: "2.12.10"
|
|
MESOS_VERSION: 1.0.0
|
|
SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
|
|
SPARK_GITHUB_URL: https://github.com/apache/spark
|