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 Pitrou <anto...@python.org> wrote: > > 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 the "docs/" directory - this will generate the > documentation using Sphinx > > I guess that step 2) is what you're missing right now? > > As for the Parquet file: does it prevent you from building the Parquet > documentation? > > Regards > > Antoine. > > > > Le 17/12/2018 à 00:15, Antonio Cavallo a écrit : > > 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/jira/browse/ARROW-4050 > > ). > > > > So I removed the parquet documentation.. but I'm still having issues with > > the arrow/docs/source/python/generated part: how do I create it? > > > > Thanks > > > > > > > > On Fri, 14 Dec 2018 at 16:20, Antoine Pitrou <anto...@python.org> wrote: > > > >> > >> 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 écrit : > >>> 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 <anto...@python.org> > wrote: > >>> > >>>> > >>>> 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 integrates the C++ API documentation in a larger Sphinx > >>>> documentation also holding the format specification and Python docs. > >>>> This allows us to add cross-references very easily and make the whole > >>>> documentation more cohesive. > >>>> > >>>> To accompany this transformation, I have started writing some prose > >>>> documentation about fundamental concepts in the C++ API. I have > >>>> uploaded a snapshot build of this work-in-progress here: > >>>> https://pitrou.net/arrowdevdoc/cpp/index.html > >>>> > >>>> Comments and suggestions are welcome. > >>>> > >>>> Regards > >>>> > >>>> Antoine. > >>>> > >>> > >> > > >
