[arrow] branch master updated: ARROW-4127: [Documentation][Python] Add instructions to build with Docker

[we...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wesm 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 c569a4c  ARROW-4127: [Documentation][Python] Add instructions to build with Docker
c569a4c is described below

commit c569a4c5684938230bf99e6b20b401322760089d
Author: Antonio Cavallo <a....@cavallinux.eu>
AuthorDate: Fri Jan 4 12:13:54 2019 -0600

    ARROW-4127: [Documentation][Python] Add instructions to build with Docker
    
    Author: Antonio Cavallo <a....@cavallinux.eu>
    
    Closes #3281 from cav71/documentation and squashes the following commits:
    
    a1c5dab21 <Antonio Cavallo> Add Docker documentation build instructions
---
 docs/source/building.rst           | 21 +++++++++++++++++++++
 docs/source/python/development.rst |  5 +++++
 2 files changed, 26 insertions(+)

diff --git a/docs/source/building.rst b/docs/source/building.rst
index 0fb4486..dfa8574 100644
--- a/docs/source/building.rst
+++ b/docs/source/building.rst
@@ -15,6 +15,8 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
+.. _building-docs:
+
 Building the Documentation
 ==========================
 
@@ -69,3 +71,22 @@ 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
 you made.
+
+
+.. _building-docker:
+
+Building with Docker
+--------------------
+
+You can use Docker to build the documentation:
+
+.. code-block:: shell
+
+  docker-compose build cpp
+  docker-compose build python
+  docker-compose build docs
+  docker-compose run docs
+
+The final output is located under [#]_::
+
+  docs/_build/html
diff --git a/docs/source/python/development.rst b/docs/source/python/development.rst
index ba8cfef..0bc1c62 100644
--- a/docs/source/python/development.rst
+++ b/docs/source/python/development.rst
@@ -364,3 +364,8 @@ Getting ``python-test.exe`` to run is a bit tricky because your
    set PYTHONHOME=%CONDA_PREFIX%
 
 Now ``python-test.exe`` or simply ``ctest`` (to run all tests) should work.
+
+Building the Documentation
+==========================
+
+See :ref:`building-docs` for instructions to build the HTML documentation.