[GitHub] [arrow-cookbook] lidavidm commented on a diff in pull request #193: Toddfarmer/contributing java dependencies

[GitBox <gi...@apache.org>]

lidavidm commented on code in PR #193:
URL: https://github.com/apache/arrow-cookbook/pull/193#discussion_r868256277


##########
java/CONTRIBUTING.rst:
##########
@@ -1,13 +1,27 @@
 Building the Java Cookbook
 =========================
-
 The Java cookbook uses the Sphinx documentation system.
 
-Running ``make java`` from the cookbook root directory (the one where
-the ``README.rst`` exists) will install all necessary dependencies
-and will compile the cookbook to HTML.
+Dependencies
+-------------------------
+The following are required to successfully build the Java cookbook:
+
+Python
+^^^^^^^^^^^^^^^^^^^^^^^^^
+The cookbook build tooling depends upon Python, and the ability to
+install needed packages via pip, to build the Java cookbook.  The
+dependency packages managed via pip by build scripts are found at
+`requirements.txt <requirements.txt>`_.
+
+sphinx-build
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Building the Java cookbook requires Sphinx build tools:
 
-For java cookbook we are running these with Java Shell tool -
+`sphinx-build <https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`_

Review Comment:
   This is installed as part of requirements.txt right? So "all" you need is Python and JShell?



##########
java/CONTRIBUTING.rst:
##########
@@ -21,6 +35,13 @@ For java cookbook we are running these with Java Shell tool -
     > jshell --version
     jshell 11.0.14
 
+
+Build Process
+-------------------------
+Run ``make java`` from the cookbook root directory (the one where
+the ``README.rst`` exists) to install all necessary dependencies
+and will compile the cookbook to HTML.

Review Comment:
   ```suggestion
   and compile the cookbook to HTML.
   ```



-- 
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: github-unsubscribe@arrow.apache.org

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