Re: C++ documentation overhaul

2018-12-27 Thread Uwe L. Korn
I also see this problem. This is due to the underlying filesystem on macOS being case insensitive. The fix is to make your file system case sensitive (this is possible but takes a while) We have two generated files pyarrow.array.rst and pyarrow.Array.rst. For me the latter is the one that relia

Re: C++ documentation overhaul

2018-12-18 Thread Antoine Pitrou
Le 18/12/2018 à 02:44, Antonio Cavallo a écrit : > Mmm, done that #1, #2 and #3 > It looks when I do a make html I receive thid: > > /Users/antonio/Projects/cav71.arrow/arrow/docs/source/python/api.rst:30:toctree > references unknown document 'python/generated/pyarrow.field' I don't get this er

Re: C++ documentation overhaul

2018-12-17 Thread Antonio Cavallo
Mmm, done that #1, #2 and #3 It looks when I do a make html I receive thid: /Users/antonio/Projects/cav71.arrow/arrow/docs/source/python/api.rst:30:toctree references unknown document 'python/generated/pyarrow.field' I can see api definitions under tough: find arrow/docs -name generated -type d .

Re: C++ documentation overhaul

2018-12-17 Thread Antonio Cavallo
Thanks Krisztian. I'm moving my first baby steps in the project, and documenting them as I go through them On Mon, 17 Dec 2018 at 12:30, Krisztián Szűcs wrote: > You can also build the documentations via docker-compose, see: > https://github.com/apache/arrow/blob/master/docker-compose.yml#L206

Re: C++ documentation overhaul

2018-12-17 Thread Krisztián Szűcs
You can also build the documentations via docker-compose, see: https://github.com/apache/arrow/blob/master/docker-compose.yml#L206 You can inspect the required steps from the Dockerfile itself: https://github.com/apache/arrow/blob/master/docs/Dockerfile On Mon, Dec 17, 2018 at 10:50 AM Antoine Pi

Re: C++ documentation overhaul

2018-12-17 Thread Antoine Pitrou
Hi Antonio, It seems like we lack a documentation of how to build the documentation ;-) Currently, this is what you need to do: 1) Compile and install PyArrow 2) Run "doxygen" in the "cpp/apidoc/" directory - this will generate the XML files for the C++ API documentation 3) Run "make html" in

Re: C++ documentation overhaul

2018-12-16 Thread Antonio Cavallo
Hi Antoine, I've just got at some point in the documentation build (macos using conda and python 3.7) following the instructions in: arrow/docs/source/python/development.rst So far so good but I had a crash while reading the parquest file (I've opened a jira qithe details https://issues.apache.org

Re: C++ documentation overhaul

2018-12-14 Thread Antoine Pitrou
Hi Antonio, Everything is done in the main Arrow repository in a regular fashion (e.g. you can open Pull Requests there). Help on the documentation is welcome, as many aspects are missing currently. Feel free to ask any questions! Regards Antoine. Le 14/12/2018 à 16:09, Antonio Cavallo a é

Re: C++ documentation overhaul

2018-12-14 Thread Antonio Cavallo
Hi Antoine, I'm trying to learn about arrow, would it possible for me to help with the documentation? Do you have a repository I can contribute to? Thanks On Wed, 12 Dec 2018 at 09:13, Antoine Pitrou wrote: > > Hello, > > We are doing a refactor of the C++ documentation which will appear in > 0

Re: C++ documentation overhaul

2018-12-12 Thread Wes McKinney
hi Antoine, Thank you for taking the lead on this initiative -- I think many will agree it is long overdue =) Luckily many of our abstractions and APIs have stabilized enough that it doesn't seem like many parts of the basic documentation will have to be written and rewritten! I started reading t

C++ documentation overhaul

2018-12-12 Thread Antoine Pitrou
Hello, We are doing a refactor of the C++ documentation which will appear in 0.12.0. Currently, the main entry point of the C++ documentation is a Doxygen-generated API documentation in the traditional format, together with a couple MarkDown pages covering some example use cases. The rewrite i