This is an automated email from the ASF dual-hosted git repository.
lidavidm 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 8fe4ea5225 MINOR: [Docs] Standardize on arrow parent directory for
build instructions (#13637)
8fe4ea5225 is described below
commit 8fe4ea522516840f49a34f615818cf482a58ca0f
Author: Todd Farmer <[email protected]>
AuthorDate: Tue Jul 19 09:37:30 2022 -0600
MINOR: [Docs] Standardize on arrow parent directory for build instructions
(#13637)
The C++ and Python build instructions use the arrow parent directory
([example](https://arrow.apache.org/docs/developers/python.html#python-development)).
The docs build instructions should do the same.
Authored-by: Todd Farmer <[email protected]>
Signed-off-by: David Li <[email protected]>
---
docs/source/developers/documentation.rst | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/docs/source/developers/documentation.rst
b/docs/source/developers/documentation.rst
index 1a2d3fce3f..497bce8f96 100644
--- a/docs/source/developers/documentation.rst
+++ b/docs/source/developers/documentation.rst
@@ -30,7 +30,7 @@ If you're using Conda, the required software can be installed
in a single line:
.. code-block:: shell
- conda install -c conda-forge --file=ci/conda_env_sphinx.txt
+ conda install -c conda-forge --file=arrow/ci/conda_env_sphinx.txt
Otherwise, you'll first need to install `Doxygen <http://www.doxygen.nl/>`_
yourself (for example from your distribution's official repositories, if
@@ -39,7 +39,7 @@ following command:
.. code-block:: shell
- pip install -r docs/requirements.txt
+ pip install -r arrow/docs/requirements.txt
Building
--------
@@ -55,7 +55,7 @@ These two steps are mandatory and must be executed in order.
.. code-block:: shell
- pushd cpp/apidoc
+ pushd arrow/cpp/apidoc
doxygen
popd
@@ -71,7 +71,7 @@ These two steps are mandatory and must be executed in order.
.. code-block:: shell
- pushd docs
+ pushd arrow/docs
make html
popd
@@ -82,8 +82,8 @@ These two steps are mandatory and must be executed in order.
will also not build without CUDA support having been built.
After these steps are completed, the documentation is rendered in HTML
-format in ``docs/_build/html``. In particular, you can point your browser
-at ``docs/_build/html/index.html`` to read the docs and review any changes
+format in ``arrow/docs/_build/html``. In particular, you can point your
browser
+at ``arrow/docs/_build/html/index.html`` to read the docs and review any
changes
you made.
Building with Docker
@@ -109,7 +109,7 @@ You can build documentation in a single directory without
needing to install
all of the pre-requisites by installing sphinx, setting up a temporary
index in the directory you want to build and then building that directory.
-The example below shows how to do this in the ``developers`` directory.
+The example below shows how to do this in the ``arrow/docs/source/developers``
directory.
Install ``sphinx``:
@@ -117,6 +117,12 @@ Install ``sphinx``:
pip install sphinx
+Navigate to the ``arrow/docs`` directory:
+
+.. code-block:: shell
+
+ cd arrow/docs
+
Create an temporary index file ``temp_index.rst`` file in the target directory:
.. code-block:: shell
