toddfarmer commented on code in PR #193: URL: https://github.com/apache/arrow-cookbook/pull/193#discussion_r872881541
########## 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: I'm not entirely sure I understand, but my (new) laptop has only python3 installed: ``` todd@pop-os:~/arrow/java$ pip --version pip 22.0.2 from /usr/lib/python3/dist-packages/pip (python 3.10) todd@pop-os:~/arrow/java$ pip3 --version pip 22.0.2 from /usr/lib/python3/dist-packages/pip (python 3.10) todd@pop-os:~/arrow/java$ python --version Command 'python' not found, did you mean: command 'python3' from deb python3 command 'python' from deb python-is-python3 todd@pop-os:~/arrow/java$ python3 --version Python 3.10.4 ``` I don't have the output handy from the initial run after installing pip, but I can revert to that state (removing all pip modules, removing sphinx-build via apt) and try to recreate, if useful. I just know that installing pip allowed the build script to proceed, but it still failed with the error cited above, with missing sphinx-build. Executing the apt command referenced in the error message resolved it for me. -- 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]
