From 8ff87adf08da483b268eae8872835a7ac0f04dc8 Mon Sep 17 00:00:00 2001 From: "Uwe L. Korn" Date: Mon, 8 May 2017 19:04:38 +0200 Subject: [PATCH] ARROW-957: [Doc] Add HDFS and Windows documents to doxygen output --- cpp/{doc => apidoc}/HDFS.md | 0 cpp/{doc => apidoc}/Windows.md | 6 ++++-- cpp/apidoc/index.md | 6 ++++++ 3 files changed, 10 insertions(+), 2 deletions(-) rename cpp/{doc => apidoc}/HDFS.md (100%) rename cpp/{doc => apidoc}/Windows.md (94%) diff --git a/cpp/doc/HDFS.md b/cpp/apidoc/HDFS.md similarity index 100% rename from cpp/doc/HDFS.md rename to cpp/apidoc/HDFS.md diff --git a/cpp/doc/Windows.md b/cpp/apidoc/Windows.md similarity index 94% rename from cpp/doc/Windows.md rename to cpp/apidoc/Windows.md index 64f6a1b98f6..b9a6143a744 100644 --- a/cpp/doc/Windows.md +++ b/cpp/apidoc/Windows.md @@ -26,7 +26,9 @@ other development instructions for Windows here. Microsoft provides the free Visual Studio 2017 Community edition. When doing development, you must launch the developer command prompt using -```"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsDevCmd.bat" -arch=amd64``` +``` +"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsDevCmd.bat" -arch=amd64 +``` It's easiest to configure a console emulator like [cmder][3] to automatically launch this when starting a new development console. @@ -80,4 +82,4 @@ cmake --build . --config Release [1]: https://conda.io/miniconda.html [2]: https://conda-forge.github.io/ -[3]: http://cmder.net/ \ No newline at end of file +[3]: http://cmder.net/ diff --git a/cpp/apidoc/index.md b/cpp/apidoc/index.md index fdac4969beb..fc10e0fddeb 100644 --- a/cpp/apidoc/index.md +++ b/cpp/apidoc/index.md @@ -27,6 +27,12 @@ the usage of the C++ API for Arrow and the leaf libraries that add additional functionality such as using [jemalloc](http://jemalloc.net/) as an allocator for Arrow structures. +Table of Contents +----------------- + + * Instructions on how to build Arrow C++ on [Windows](Windows.md) + * How to access [HDFS](HDFS.md) + Getting Started ---------------