Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-32584][PYTHON][DOCS] Exclude _images and _sources that are generated by Sphinx in Jekyll build #29402

Closed
wants to merge 1 commit into from

Conversation

HyukjinKwon
Copy link
Member

@HyukjinKwon HyukjinKwon commented Aug 11, 2020

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:
Screen Shot 2020-08-11 at 1 52 46 PM

After:
Screen Shot 2020-08-11 at 1 49 00 PM

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:

SKIP_SCALADOC=1 SKIP_RDOC=1 SKIP_SQLDOC=1 jekyll serve --watch

@HyukjinKwon
Copy link
Member Author

cc @viirya can you take a quick look when you're available?

@SparkQA
Copy link

SparkQA commented Aug 11, 2020

Test build #127307 has finished for PR 29402 at commit 3cb7891.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

Copy link
Member

@viirya viirya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@HyukjinKwon
Copy link
Member Author

Thanks @viirya! Merged to master.

@HyukjinKwon HyukjinKwon deleted the SPARK-32584 branch December 7, 2020 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants