[
https://issues.apache.org/jira/browse/ARROW-3629?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16709088#comment-16709088
]
Tanya Schlusser commented on ARROW-3629:
----------------------------------------
Pull request [#3089|https://github.com/apache/arrow/pull/3089], provided I
understood this correctly and it only entails adding a single line to the
{color:#654982}{{python/doc/source/api.rst}}{color}.
----
Comment:
The doc build was difficult, but possibly because I'm a noob. I'm commenting
rather than making a JIRA issue because I have no idea whether these are actual
issues or just a newbie's lack of knowledge. Running
{color:#654982}{{dev/gen_apidocs.sh}}{color} on a clean pull with my single
line to {color:#654982}{{api.rst}}{color} changed failed:
The {color:#654982}{{iwyu}}{color} image in
{color:#654982}{{dev/docker-compose.yml}}{color} failed with this path issue:
- {color:#654982}{{ERROR: build path <my-path>/arrow/dev/iwyu either does
not exist, is not accessible, or is not a valid URL.}}{color}
- I commented it out and then could continue.
The Java docs wouldn't compile either at first:
- I think because there's a {color:#654982}{{conda install}}{color} for a
second version of {color:#654982}{{maven}}{color} below the
{color:#654982}{{apt-get install maven}}{color} in the
[Dockerfile|https://github.com/apache/arrow/blob/master/dev/gen_apidocs/Dockerfile],
which puts Java 11 in the front of the {color:#654982}{{PATH}}{color} breaking
the lookup for class {color:#654982}{{javax.annotation.Generated}}{color} which
moves from [Java
8|https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html] to
[Java
9|https://docs.oracle.com/javase/9/docs/api/javax/annotation/processing/Generated.html]
(and here is where it landed in [Java
11|https://docs.oracle.com/en/java/javase/11/docs/api/java.compiler/javax/annotation/processing/Generated.html])
- when I deleted that line in the Dockerfile, the Java code compiled but
didn't pass a test, because of a different missing dependency (that I didn't
note; happy to figure it out if it's actually meaningful)
- so I commented out the Java build section in
{color:#654982}{{dev/gen_apidocs/create_documents.sh}}{color}
The Javascript docs failed on a dependency I didn't note (happy to; just didn't
want to waste time if it's my noob problem)
- so I commented it out too; then the remaining doc generation worked
Please disregard if it's my lack of understanding. Otherwise I am happy to
investigate further/add issues :).
> [Python] Add write_to_dataset to Python Sphinx API listing
> ----------------------------------------------------------
>
> Key: ARROW-3629
> URL: https://issues.apache.org/jira/browse/ARROW-3629
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Python
> Reporter: Wes McKinney
> Priority: Major
> Labels: pull-request-available
> Fix For: 0.12.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
