Skip to content

Commit 8c1dfc7

Browse files
authored
docs: Remove empty developer guide pages (#9026)
- Remove empty "embedding Vortex" pages from docs. - Remove `make.bat` - Move C++ quickstart to quickstart folder. - Update duckdb docs for newer read syntax. - Remove obsolete duckdb developer quide page. --------- Signed-off-by: Mikhail Kot <mikhail@spiraldb.com> Signed-off-by: myrrc <mikhail@spiraldb.com>
1 parent b15394a commit 8c1dfc7

13 files changed

Lines changed: 20 additions & 238 deletions

File tree

docs/api/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,5 @@ maxdepth: 2
1111
python/index
1212
Rust API <https://docs.rs/vortex>
1313
c/index
14-
cpp/index
1514
java/index
1615
```

docs/developer-guide/embedding/cxx.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/developer-guide/embedding/ffi.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/developer-guide/embedding/gpu.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/developer-guide/embedding/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/developer-guide/embedding/scan-api.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/developer-guide/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ maxdepth: 2
88
---
99
1010
extending/index
11-
embedding/index
1211
language-bindings
1312
benchmarking
1413
```
@@ -37,6 +36,5 @@ caption: Integrations
3736
---
3837
3938
integrations/datafusion
40-
integrations/duckdb
4139
integrations/spark
4240
```

docs/developer-guide/integrations/duckdb.md

Lines changed: 0 additions & 69 deletions
This file was deleted.
Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
C++ API
2-
=======
1+
C++ Quickstart
2+
==============
33

4-
The Vortex C++ API allows you to read and write ``.vortex`` files directly or
5-
via an Arrow compatibility layer like `nanoarrow
6-
<https://arrow.apache.org/nanoarrow/>`_. The only dependency apart from Vortex
7-
is ``nanoarrow``.
4+
Vortex C++ API allows you to read and write ``.vortex`` files directly or via
5+
an Arrow compatibility layer like `nanoarrow <https://arrow.apache.org/nanoarrow/>`_.
6+
The only dependency apart from Vortex is ``nanoarrow``.
87

98
.. note::
109
C++ API is a work in progress. Please reach out to us if you are interested
@@ -57,7 +56,7 @@ Assuming you have Vortex files ``people0``, ``people1``, and ``me`` in a local f
5756
each containing U8 column "age" and U16 column "height", this is how you
5857
print all ages for specific heights:
5958

60-
.. literalinclude:: ../../../lang/cpp/examples/reader.cpp
59+
.. literalinclude:: ../../lang/cpp/examples/reader.cpp
6160
:language: cpp
6261
:start-after: docs:begin:example
6362
:end-before: docs:end:example
@@ -148,7 +147,7 @@ Now let's write the first files to be read by our previous example.
148147
Source code for this example is `writer.cpp
149148
<https://github.com/vortex-data/vortex/tree/develop/lang/cpp/examples/writer.cpp>`_.
150149

151-
.. literalinclude:: ../../../lang/cpp/examples/writer.cpp
150+
.. literalinclude:: ../../lang/cpp/examples/writer.cpp
152151
:language: cpp
153152
:start-after: docs:begin:example
154153
:end-before: docs:end:example

docs/getting-started/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@ caption: Language Libraries
2424
2525
Python Quickstart <python>
2626
Rust Quickstart <rust>
27+
C++ Quickstart <cpp>
2728
Java Quickstart <java>
2829
```

0 commit comments

Comments
 (0)