File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 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+ Contributor Guide
20+ =================
21+
22+ Guides for contributors to the DataFusion in Python project.
23+
24+ .. toctree ::
25+ :maxdepth: 2
26+
27+ introduction
28+ ffi
Original file line number Diff line number Diff line change @@ -52,47 +52,18 @@ Example
5252 df.show()
5353
5454
55- .. _toc.links :
56- .. toctree ::
57- :hidden:
58- :maxdepth: 1
59- :caption: LINKS
55+ Further reading:
6056
61- Github and Issue Tracker <https://github.com/apache/datafusion-python >
62- Rust's API Docs <https://docs.rs/datafusion/latest/ datafusion/ >
63- Code of conduct <https://github.com/apache/ datafusion/blob/main/CODE_OF_CONDUCT.md >
64- Examples <https://github.com/apache/datafusion-python/tree /main/examples >
57+ * ` Examples <https://github.com/apache/datafusion-python/tree/main/examples >`_ — runnable scripts demonstrating common patterns.
58+ * ` GitHub repository and issue tracker <https://github.com/apache/ datafusion-python >`_.
59+ * ` Rust API docs <https://docs.rs/ datafusion/latest/datafusion/ >`_ for the underlying engine.
60+ * ` Apache DataFusion code of conduct <https://github.com/apache/datafusion/blob /main/CODE_OF_CONDUCT.md >`_.
6561
66- .. _toc.guide :
67- .. toctree ::
68- :hidden:
69- :maxdepth: 1
70- :caption: USER GUIDE
71-
72- user-guide/introduction
73- user-guide/basics
74- user-guide/data-sources
75- user-guide/dataframe/index
76- user-guide/common-operations/index
77- user-guide/io/index
78- user-guide/configuration
79- user-guide/distributing-work
80- user-guide/sql
81- user-guide/upgrade-guides
82- user-guide/ai-coding-assistants
83-
84-
85- .. _toc.contributor_guide :
86- .. toctree ::
87- :hidden:
88- :maxdepth: 1
89- :caption: CONTRIBUTOR GUIDE
9062
91- contributor-guide/introduction
92- contributor-guide/ffi
93-
94- .. _toc.api :
9563.. toctree ::
9664 :hidden:
9765 :maxdepth: 1
98- :caption: API
66+
67+ user-guide/index
68+ contributor-guide/index
69+ API Reference <autoapi/index >
Original file line number Diff line number Diff line change 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+ User Guide
20+ ==========
21+
22+ The user guide walks through installing DataFusion in Python, building queries
23+ with the DataFrame API or SQL, reading and writing data, and tuning execution.
24+
25+ .. toctree ::
26+ :maxdepth: 2
27+
28+ introduction
29+ basics
30+ data-sources
31+ dataframe/index
32+ common-operations/index
33+ io/index
34+ configuration
35+ distributing-work
36+ sql
37+ upgrade-guides
38+ ai-coding-assistants
You can’t perform that action at this time.
0 commit comments