amol- commented on code in PR #193: URL: https://github.com/apache/arrow-cookbook/pull/193#discussion_r870489645
########## 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: Yeah, that `cd java && pip install -r requirements.txt` should be installing the dependencies. A common reason for that is if you have multiple versions of Python installed (usually Python2 and Python3) and pip is available for one of them, but the default interpreter is a different one. We could probably improve that by switching the `pip install` to `python -m pip install` which should guarantee you use the pip from your default interpreter. ########## 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: Yeah, that `cd java && pip install -r requirements.txt` should be installing the dependencies. A common reason for that is if you have multiple versions of Python installed (usually Python2 and Python3) and pip is available for one of them, but the default interpreter is a different one. We could probably improve that by switching the `pip install` to `python -m pip install` which should guarantee you use the pip from your default interpreter. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
