[SPARK-32584][PYTHON][DOCS] Exclude _images and _sources that are generated by Sphinx in Jekyll build #29402
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 and here. 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: