AlenkaF commented on code in PR #46583:
URL: https://github.com/apache/arrow/pull/46583#discussion_r2107317681
##########
docs/source/index.rst:
##########
@@ -92,38 +92,16 @@ target environment.**
developers/index
-Implementations
Review Comment:
There was quite a bit of discussion in the PR that introduced this header
sections: https://github.com/apache/arrow/pull/36591
I remember we spent some time deciding on the title here (Libraries,
Implementations, or something else). While I'm personally fine with either
option, I think minimizing changes to the headers might help avoid confusion
for users. What do you think?
##########
docs/source/index.rst:
##########
@@ -92,38 +92,16 @@ target environment.**
developers/index
-Implementations
----------------
-
-.. _toc.usage:
+.. _toc.libraries:
.. toctree::
- :maxdepth: 1
-
- C/GLib <c_glib/index>
- C++ <cpp/index>
- C# <https://github.com/apache/arrow/blob/main/csharp/README.md>
- Go <https://arrow.apache.org/go/>
- Java <java/index>
- JavaScript <js/index>
- Julia <https://arrow.apache.org/julia/>
- MATLAB <https://github.com/apache/arrow/blob/main/matlab/README.md>
- nanoarrow <https://arrow.apache.org/nanoarrow/>
- Python <python/index>
- R <r/index>
- Ruby <https://github.com/apache/arrow/blob/main/ruby/README.md>
- Rust <https://docs.rs/crate/arrow/>
- status
-
-Examples
---------
-
-.. _toc.cookbook:
+ :maxdepth: 2
Review Comment:
The list of all the implementations is missing here, see preview docs
http://crossbow.voltrondata.com/pr_docs/46583/index.html#libraries.
I think it would be great to keep that on the main page.
Currently: https://arrow.apache.org/docs/index.html
##########
docs/source/conf.py:
##########
@@ -341,16 +341,10 @@
"image_light": "_static/arrow.png",
"image_dark": "_static/arrow-dark.png",
},
- "header_links_before_dropdown": 2,
- "header_dropdown_text": "Implementations",
+ "header_links_before_dropdown": 4,
"navbar_align": "left",
"navbar_end": ["kapa-ai-bot.html", "version-switcher", "theme-switcher",
"navbar-icon-links"],
"icon_links": [
- {
- "name": "GitHub",
- "url": "https://github.com/apache/arrow";,
- "icon": "fa-brands fa-square-github",
- },
Review Comment:
Hm, I am not sure about this. A link to the main project repo is still
valuable, I think.
##########
docs/source/libraries/index.rst:
##########
@@ -0,0 +1,78 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. _libraries:
+
+Libraries
+===========
+
+
+Documentation and source code for Apache Arrow libraries
+
+.. list-table::
+ :header-rows: 1
+
+ * - Language
+ - Docs
+ - Source
+ * - C++
+ - `C++ Docs <https://arrow.apache.org/docs/cpp>`_
+ - `C++ Source <https://github.com/apache/arrow/tree/main/cpp>`_
+ * - C GLib
+ - `C GLib Docs <https://arrow.apache.org/docs/c_glib>`_
+ - `C GLib Source <https://github.com/apache/arrow/tree/main/c_glib>`_
+ * - C#
+ - `C# Docs <https://github.com/apache/arrow/blob/main/csharp/README.md>`_
+ - `C# Source <https://github.com/apache/arrow/tree/main/csharp>`_
+ * - Go
+ - `Go Docs <https://godoc.org/github.com/apache/arrow/go/arrow>`_
+ - `Go Source <https://github.com/apache/arrow-go>`_
+ * - Java
+ - `Java Docs <https://arrow.apache.org/docs/java>`_
+ - `Java Source <https://github.com/apache/arrow-java>`_
+ * - JavaScript
+ - `JavaScript Docs <https://arrow.apache.org/docs/js>`_
+ - `JavaScript Source <https://github.com/apache/arrow-js>`_
+ * - Julia
+ - `Julia Docs <https://arrow.apache.org/julia/>`_
+ - `Julia Source <https://github.com/apache/arrow-julia>`_
+ * - MATLAB
+ - `MATLAB Docs
<https://github.com/apache/arrow/blob/main/matlab/README.md>`_
+ - `MATLAB Source <https://github.com/apache/arrow/tree/main/matlab>`_
+ * - Python
+ - `Python Docs <https://arrow.apache.org/docs/python>`_
+ - `Python Source <https://github.com/apache/arrow/tree/main/python>`_
+ * - R
+ - `R Docs <https://arrow.apache.org/docs/r>`_
+ - `R Source <https://github.com/apache/arrow/tree/main/r>`_
+ * - Ruby
+ - `Ruby Docs <https://github.com/apache/arrow/blob/main/ruby/README.md>`_
+ - `Ruby Source <https://github.com/apache/arrow/tree/main/ruby>`_
+ * - Rust
+ - `Rust Docs <https://docs.rs/arrow/latest>`_
+ - `Rust Source <https://github.com/apache/arrow-rs>`_
+
+
+Examples
+--------
+
+The Apache Arrow project provides example code in multiple languages.
+
+- `C++ cookbook <https://arrow.apache.org/cookbook/cpp/>`__
+- `Java cookbook <https://arrow.apache.org/cookbook/java/>`__
+- `Python cookbook <https://arrow.apache.org/cookbook/py/>`__
+- `R cookbook <https://arrow.apache.org/cookbook/r/>`__
Review Comment:
If we do not need a sidebar list of the implementations, maybe we could use
`:html_theme.sidebar_secondary.remove:` as here:
https://raw.githubusercontent.com/apache/arrow/refs/heads/main/docs/source/index.rst
That should enable a wider body and remove the TOC.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
