toddfarmer commented on code in PR #193: URL: https://github.com/apache/arrow-cookbook/pull/193#discussion_r870386364
########## 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: Right, I did `make java` from the repo root, but it still failed on missing sphinx-build: ``` todd@pop-os:~/arrow-cookbook$ make java >>> Installing Java Dependencies <<< cd java && pip install -r requirements.txt ... >>> Building Java Cookbook <<< cd java && make html make[1]: Entering directory '/home/todd/arrow-cookbook/java' /bin/sh: 1: sphinx-build: not found make[1]: *** [Makefile:20: html] Error 127 make[1]: Leaving directory '/home/todd/arrow-cookbook/java' make: *** [Makefile:81: java] Error 2 todd@pop-os:~/arrow-cookbook$ sphinx-build Command 'sphinx-build' not found, but can be installed with: sudo apt install python3-sphinx ``` -- 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]
