Skip to content

Commit 9be6fbe

Browse files
xhochyxhochy
committed
Merge C++ and Python documentation
1 parent 42a52d7 commit 9be6fbe

22 files changed

Lines changed: 209 additions & 40 deletions

‎cpp/apidoc/Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1919,7 +1919,7 @@ MAN_LINKS = NO
19191919
# captures the structure of the code including all documentation.
19201920
# The default value is: NO.
19211921

1922-
GENERATE_XML = NO
1922+
GENERATE_XML = YES
19231923

19241924
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
19251925
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

‎cpp/src/arrow/array.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,8 @@ class ARROW_EXPORT PrimitiveArray : public FlatArray {
397397
const uint8_t* raw_values_;
398398
};
399399

400+
401+
/// Concrete Array class for numeric data.
400402
template <typename TYPE>
401403
class ARROW_EXPORT NumericArray : public PrimitiveArray {
402404
public:

‎python/doc/.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
# under the License.
1717

1818
_build
19-
source/generated
19+
source/python/generated

‎python/doc/source/conf.py‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@
5757
'sphinx.ext.viewcode',
5858
'sphinx.ext.napoleon',
5959
'IPython.sphinxext.ipython_directive',
60-
'IPython.sphinxext.ipython_console_highlighting'
60+
'IPython.sphinxext.ipython_console_highlighting',
61+
'breathe'
6162
]
6263

6364
# Show members for classes in .. autosummary
@@ -77,6 +78,9 @@
7778
# Add any paths that contain templates here, relative to this directory.
7879
templates_path = ['_templates']
7980

81+
breathe_projects = { "arrow_cpp": "../../../cpp/apidoc/xml" }
82+
breathe_default_project = "arrow_cpp"
83+
8084
# The suffix(es) of source filenames.
8185
# You can specify multiple suffix as a list of string:
8286
#
@@ -93,7 +97,7 @@
9397
master_doc = 'index'
9498

9599
# General information about the project.
96-
project = u'pyarrow'
100+
project = u'Apache Arrow'
97101
copyright = u'2016-2018 Apache Software Foundation'
98102
author = u'Apache Software Foundation'
99103

@@ -180,7 +184,7 @@
180184
# The name for this set of Sphinx documents.
181185
# "<project> v<release> documentation" by default.
182186
#
183-
# html_title = u'pyarrow v0.1.0'
187+
# html_title = u'Apache Arrow v0.1.0'
184188

185189
# A shorter title for the navigation bar. Default is the same as html_title.
186190
#
@@ -280,7 +284,7 @@
280284
# html_search_scorer = 'scorer.js'
281285

282286
# Output file base name for HTML help builder.
283-
htmlhelp_basename = 'pyarrowdoc'
287+
htmlhelp_basename = 'arrowdoc'
284288

285289
# -- Options for LaTeX output ---------------------------------------------
286290

@@ -306,7 +310,7 @@
306310
# (source start file, target name, title,
307311
# author, documentclass [howto, manual, or own class]).
308312
latex_documents = [
309-
(master_doc, 'pyarrow.tex', u'pyarrow Documentation',
313+
(master_doc, 'arrow.tex', u'Apache Arrow Documentation',
310314
u'Apache Arrow Team', 'manual'),
311315
]
312316

@@ -348,7 +352,7 @@
348352
# One entry per manual page. List of tuples
349353
# (source start file, name, description, authors, manual section).
350354
man_pages = [
351-
(master_doc, 'pyarrow', u'pyarrow Documentation',
355+
(master_doc, 'arrow', u'Apache Arrow Documentation',
352356
[author], 1)
353357
]
354358

@@ -363,8 +367,8 @@
363367
# (source start file, target name, title, author,
364368
# dir menu entry, description, category)
365369
texinfo_documents = [
366-
(master_doc, 'pyarrow', u'pyarrow Documentation',
367-
author, 'pyarrow', 'One line description of project.',
370+
(master_doc, 'arrow', u'Apache Arrow Documentation',
371+
author, 'Apache Arrow', 'One line description of project.',
368372
'Miscellaneous'),
369373
]
370374

‎python/doc/source/cpp/api.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
*************
19+
API Reference
20+
*************
21+
22+
.. toctree::
23+
:maxdepth: 2
24+
:caption: Getting Started
25+
26+
api/array

‎python/doc/source/cpp/api/array.rst‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
Array types
19+
=============
20+
21+
.. doxygenclass:: arrow::Array
22+
:project: arrow_cpp
23+
:members:
24+
25+
.. doxygenclass:: arrow::DictionaryArray
26+
:project: arrow_cpp
27+
:members:
28+
29+
non-nested array types
30+
----------------------
31+
32+
.. doxygenclass:: arrow::FlatArray
33+
:project: arrow_cpp
34+
:members:
35+
36+
.. doxygenclass:: arrow::NullArray
37+
:project: arrow_cpp
38+
:members:
39+
40+
.. doxygenclass:: arrow::BinaryArray
41+
:project: arrow_cpp
42+
:members:
43+
44+
.. doxygenclass:: arrow::StringArray
45+
:project: arrow_cpp
46+
:members:
47+
48+
.. doxygenclass:: arrow::PrimitiveArray
49+
:project: arrow_cpp
50+
:members:
51+
52+
.. doxygenclass:: arrow::BooleanArray
53+
:project: arrow_cpp
54+
:members:
55+
56+
.. doxygenclass:: arrow::FixedSizeBinaryArray
57+
:project: arrow_cpp
58+
:members:
59+
60+
.. doxygenclass:: arrow::Decimal128Array
61+
:project: arrow_cpp
62+
:members:
63+
64+
.. doxygenclass:: arrow::NumericArray
65+
:project: arrow_cpp
66+
:members:
67+
68+
nested array types
69+
------------------
70+
71+
.. doxygenclass:: arrow::UnionArray
72+
:project: arrow_cpp
73+
:members:
74+
75+
.. doxygenclass:: arrow::ListArray
76+
:project: arrow_cpp
77+
:members:
78+
79+
.. doxygenclass:: arrow::StructArray
80+
:project: arrow_cpp
81+
:members:

‎python/doc/source/cpp/index.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
C++ Implementation
19+
==================
20+
21+
.. toctree::
22+
:maxdepth: 2
23+
:caption: Getting Started
24+
25+
api

‎python/doc/source/index.rst‎

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,24 @@
1515
.. specific language governing permissions and limitations
1616
.. under the License.
1717
18-
Python bindings for Apache Arrow
19-
================================
18+
Apache Arrow
19+
============
2020

2121
Apache Arrow is a cross-language development platform for in-memory data. It
2222
specifies a standardized language-independent columnar memory format for flat
2323
and hierarchical data, organized for efficient analytic operations on modern
2424
hardware. It also provides computational libraries and zero-copy streaming
2525
messaging and interprocess communication.
2626

27-
The Arrow Python bindings have first-class integration with NumPy, pandas, and
28-
built-in Python objects.
27+
.. toctree::
28+
:caption: Memory Format
2929

30-
This is the documentation of the Python API of Apache Arrow. For more details
31-
on the format and other language bindings see
32-
`the main page for Arrow <https://arrow.apache.org/>`_. Here will we only
33-
detail the usage of the Python API for Arrow and the leaf libraries that add
34-
additional functionality such as reading Apache Parquet files into Arrow
35-
structures.
30+
format
3631

3732
.. toctree::
3833
:maxdepth: 2
39-
:caption: Getting Started
40-
41-
install
42-
development
43-
memory
44-
data
45-
ipc
46-
filesystems
47-
plasma
48-
numpy
49-
pandas
50-
csv
51-
parquet
52-
extending
53-
api
54-
getting_involved
34+
:caption: Languages
35+
36+
language_interop
37+
cpp/index
38+
python/index

python/doc/source/api.rst renamed to python/doc/source/python/api.rst

File renamed without changes.

python/doc/source/data.rst renamed to python/doc/source/python/data.rst

File renamed without changes.

0 commit comments

Comments
 (0)