You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "nchammas (via GitHub)" <gi...@apache.org> on 2023/12/26 01:09:15 UTC

[PR] [MINOR][DOCS] Python docs also require Pandoc [spark]

nchammas opened a new pull request, #44484:
URL: https://github.com/apache/spark/pull/44484

   ### What changes were proposed in this pull request?
   
   Clarify in the README for building docs that the Python API docs also require Pandoc, not just R.
   
   ### Why are the changes needed?
   
   Attempting to build the Python API docs without Pandoc installed will yield the following error:
   
   ```
   reading sources... [  0%] getting_started/quickstart_connect                                                
   Notebook error:
   PandocMissing in getting_started/quickstart_connect.ipynb:
   Pandoc wasn't found.
   Please check that pandoc is installed:
   https://pandoc.org/installing.html
   make: *** [html] Error 2
                       ------------------------------------------------
         Jekyll 4.3.2   Please append `--trace` to the `build` command 
                        for any additional information or backtrace. 
                       ------------------------------------------------
   .../spark/docs/_plugins/copy_api_dirs.rb:130:in `<top (required)>': Python doc generation failed (RuntimeError)
   ```
   
   ### Does this PR introduce _any_ user-facing change?
   
   No.
   
   ### How was this patch tested?
   
   Via trying to build the Python docs without Pandoc.
   
   ### Was this patch authored or co-authored using generative AI tooling?
   
   No.


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [MINOR][DOCS] Python docs also require Pandoc [spark]

Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on PR #44484:
URL: https://github.com/apache/spark/pull/44484#issuecomment-1869177234

   cc @HyukjinKwon for this quick PR on building the Python docs.


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [MINOR][DOCS] Python docs also require Pandoc [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44484:
URL: https://github.com/apache/spark/pull/44484#issuecomment-1869183939

   Merged to master.


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [MINOR][DOCS] Python docs also require Pandoc [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44484: [MINOR][DOCS] Python docs also require Pandoc
URL: https://github.com/apache/spark/pull/44484


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org