[
https://issues.apache.org/jira/browse/ARROW-1455?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16225351#comment-16225351
]
ASF GitHub Bot commented on ARROW-1455:
---------------------------------------
heimir-sverrisson commented on a change in pull request #1249: ARROW-1455
[Python] Add Dockerfile for validating Dask integration
URL: https://github.com/apache/arrow/pull/1249#discussion_r147772476
##########
File path: dev/README.md
##########
@@ -113,3 +113,53 @@ Studio 2015):
```
dev/release/verify-release-candidate.bat apache-arrow-0.7.0.tar.gz
```
+
+## Creating API documentation
+
+The generation of API documentation for `C++`, `C Glib`, `Python`
+and `Java` has been Dockerized. To generate the API documentation
+run the following command:
+
+```shell
+bash dev/gen_apidocs.sh
+```
+
+This script assumes that the `parquet-cpp` Git repository
+https://github.com/apache/parquet-cpp has been cloned
+besides the Arrow repository and a `dist` directory can be created
+at the same level by the current user. Please note that most of the
+software must be built in order to create the documentation, so this
+step may take some time to run, especially the first time around as the
+Docker container will also have to be built.
+
+After successfully creating the API documentation the website can be
+run locally to browse the API documentation from the top level
+`Documentation` menu. To run the website issue the command:
+
+```shell
+bash dev/run_site.sh
+```
+
+The local URL for the website running inside the docker container
+will be shown as `Server address:` in the output of the command.
+To stop the server press `Ctrl-C` in that window.
+
+## Testing Dask integration
Review comment:
Done
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> [Python] Add Dockerfile for validating Dask integration outside of usual CI
> ---------------------------------------------------------------------------
>
> Key: ARROW-1455
> URL: https://issues.apache.org/jira/browse/ARROW-1455
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Python
> Reporter: Wes McKinney
> Assignee: Heimir Thor Sverrisson
> Labels: pull-request-available
>
> Introducing the Dask stack into Arrow's CI might be a bit heavyweight at the
> moment, but we can add a testing set up in
> https://github.com/apache/arrow/tree/master/python/testing so that this can
> be validated on an ad hoc basis in a reproducible way.
> see also ARROW-1417
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
