You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2019/02/04 15:30:19 UTC
[arrow] branch master updated: ARROW-4436: [Documentation] Update
building.rst to reflect pyarrow req
This is an automated email from the ASF dual-hosted git repository.
uwe pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 9f34a41 ARROW-4436: [Documentation] Update building.rst to reflect pyarrow req
9f34a41 is described below
commit 9f34a417a37f6d1f7061cf793292123d9749f9a9
Author: Micah Kornfield <em...@gmail.com>
AuthorDate: Mon Feb 4 16:28:58 2019 +0100
ARROW-4436: [Documentation] Update building.rst to reflect pyarrow req
Make note of the fact that pyarrow has to be installed for sphinx to successfully build the documentation.
Author: Micah Kornfield <em...@gmail.com>
Closes #3539 from emkornfield/update_build_doc and squashes the following commits:
8a3e5418 <Micah Kornfield> Fix install instructions
9468abe5 <Micah Kornfield> convert to note
---
docs/source/building.rst | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/source/building.rst b/docs/source/building.rst
index c6ff974..2239a19 100644
--- a/docs/source/building.rst
+++ b/docs/source/building.rst
@@ -59,7 +59,15 @@ These two steps are mandatory and must be executed in order.
doxygen
popd
-#. Build the complete documentation using Sphinx
+#. Build the complete documentation using Sphinx.
+
+ .. note::
+
+ This step requires the the pyarrow library is installed
+ in your python environment. One way to accomplish
+ this is to follow the build instructions at :ref:`development`
+ and then run `python setup.py install` in arrow/python
+ (it is best to do this in a dedicated conda/virtual environment).
.. code-block:: shell