This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 765fd8af update documentation for tag main
765fd8af is described below
commit 765fd8af2f954d539124bbccbfddec39479c6545
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Apr 9 19:22:52 2024 +0000
update documentation for tag main
---
main/index.html | 43 +++++++++++++++++++++++++++++++++++++++++++
main/r/pkgdown.yml | 2 +-
main/reference/python.html | 10 +++++-----
main/searchindex.js | 2 +-
4 files changed, 50 insertions(+), 7 deletions(-)
diff --git a/main/index.html b/main/index.html
index 2f98d8bf..ab294776 100644
--- a/main/index.html
+++ b/main/index.html
@@ -441,6 +441,48 @@ repository.</p>
</pre></div>
</div>
</section>
+<section id="building-with-meson">
+<h2>Building with Meson<a class="headerlink" href="#building-with-meson"
title="Link to this heading">#</a></h2>
+<p>CMake is the officially supported build system for nanoarrow. However,
+the Meson backend is an experimental feature you may also wish to try.</p>
+<p>To run the test suite with Meson, you will want to first install the
+testing dependencies via the wrap database (n.b. no wrap database entry
+exists for Arrow - that must be installed separately).</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>mkdir<span class="w"> </span>subprojects
+meson<span class="w"> </span>wrap<span class="w"> </span>install<span
class="w"> </span>gtest
+meson<span class="w"> </span>wrap<span class="w"> </span>install<span
class="w"> </span>google-benchmark
+meson<span class="w"> </span>wrap<span class="w"> </span>install<span
class="w"> </span>nlohmann_json
+</pre></div>
+</div>
+<p>The Arrow C++ library must also be discoverable via pkg-config build
+tests.</p>
+<p>You can then set up your build directory:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span>setup<span
class="w"> </span>builddir
+<span class="nb">cd</span><span class="w"> </span>builddir
+</pre></div>
+</div>
+<p>And configure your project (this could have also been done inline with
+<code class="docutils literal notranslate"><span
class="pre">setup</span></code>)</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span>configure<span
class="w"> </span>-DNANOARROW_BUILD_TESTS<span class="o">=</span><span
class="nb">true</span><span class="w"> </span>-DNANOARROW_BUILD_BENCHMARKS<span
class="o">=</span><span class="nb">true</span>
+</pre></div>
+</div>
+<p>Note that if your Arrow pkg-config profile is installed in a
+non-standard location on your system, you may pass the
+<code class="docutils literal notranslate"><span
class="pre">--pkg-config-path</span> <span class="pre"><path</span> <span
class="pre">to</span> <span class="pre">directory</span> <span
class="pre">with</span> <span class="pre">arrow.pc></span></code> to either
the
+setup or configure steps above.</p>
+<p>With the above out of the way, the <code class="docutils literal
notranslate"><span class="pre">compile</span></code> command should take care
+of the rest:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span>compile
+</pre></div>
+</div>
+<p>Upon a successful build you can execute the test suite and benchmarks
+with the following commands:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span><span
class="nb">test</span><span class="w"> </span>nanoarrow:<span class="w">
</span><span class="c1"># default test run</span>
+meson<span class="w"> </span><span class="nb">test</span><span class="w">
</span>nanoarrow:<span class="w"> </span>--wrap<span class="w">
</span>valgrind<span class="w"> </span><span class="c1"># run tests under
valgrind</span>
+meson<span class="w"> </span><span class="nb">test</span><span class="w">
</span>nanoarrow:<span class="w"> </span>--benchmark<span class="w">
</span>--verbose<span class="w"> </span><span class="c1"># run benchmarks</span>
+</pre></div>
+</div>
+</section>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Link to this
heading">#</a></h2>
<div class="toctree-wrapper compound">
@@ -512,6 +554,7 @@ repository.</p>
<nav class="bd-toc-nav page-toc"
aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#using-the-c-library">Using the C library</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#building-with-meson">Building with Meson</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#contents">Contents</a></li>
</ul>
</nav></div>
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 658590a8..72a51293 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2024-04-05T19:00Z
+last_built: 2024-04-09T19:22Z
diff --git a/main/reference/python.html b/main/reference/python.html
index 0c527f39..63c4ee63 100644
--- a/main/reference/python.html
+++ b/main/reference/python.html
@@ -422,7 +422,7 @@ it may consist of zero or more <a href="#id1"><span
class="problematic" id="id2"
</dd>
<dt>schema<span class="classifier">schema-like, optional</span></dt><dd><p>An
optional schema, passed to <a class="reference internal"
href="#nanoarrow.c_array_stream" title="nanoarrow.c_array_stream"><code
class="xref py py-func docutils literal notranslate"><span
class="pre">c_array_stream()</span></code></a>.</p>
</dd>
-<dt>device<span class="classifier">CDevice, optional</span></dt><dd><p>The
device associated with the buffers held by this Array.
+<dt>device<span class="classifier">Device, optional</span></dt><dd><p>The
device associated with the buffers held by this Array.
Defaults to the CPU device.</p>
</dd>
</dl>
@@ -526,16 +526,16 @@ Defaults to the CPU device.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.Array.device">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">device</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">CDevice</span></em><a class="headerlink"
href="#nanoarrow.Array.device" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">device</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">Device</span></em><a class="headerlink"
href="#nanoarrow.Array.device" title="Link to this definition">#</a></dt>
<dd><p>Get the device on which the buffers for this array are allocated.</p>
<section id="id9">
<h3>Examples<a class="headerlink" href="#id9" title="Link to this
heading">#</a></h3>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">array</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Array</span><span class="p">([</span><span class="mi">1</span><span
class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span
class="mi">3</span><span class="p">],</span> <span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">())</span>
<span class="gp">>>> </span><span class="n">array</span><span
class="o">.</span><span class="n">device</span>
-<span class="go"><nanoarrow.device.CDevice></span>
-<span class="go">- device_type: 1</span>
-<span class="go">- device_id: 0</span>
+<span class="go"><nanoarrow.device.Device></span>
+<span class="go">- device_type: CPU <1></span>
+<span class="go">- device_id: -1</span>
</pre></div>
</div>
</section>
diff --git a/main/searchindex.js b/main/searchindex.js
index 05571d49..03ed9b66 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["getting-started/cpp", "getting-started/index",
"getting-started/python", "getting-started/r", "index", "reference/c",
"reference/cpp", "reference/device", "reference/index", "reference/ipc",
"reference/python", "reference/r", "reference/testing", "roadmap"],
"filenames": ["getting-started/cpp.rst", "getting-started/index.rst",
"getting-started/python.rst", "getting-started/r.rst", "index.rst",
"reference/c.rst", "reference/cpp.rst", "reference/device.rst", [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["getting-started/cpp", "getting-started/index",
"getting-started/python", "getting-started/r", "index", "reference/c",
"reference/cpp", "reference/device", "reference/index", "reference/ipc",
"reference/python", "reference/r", "reference/testing", "roadmap"],
"filenames": ["getting-started/cpp.rst", "getting-started/index.rst",
"getting-started/python.rst", "getting-started/r.rst", "index.rst",
"reference/c.rst", "reference/cpp.rst", "reference/device.rst", [...]
\ No newline at end of file
