This is an automated email from the ASF dual-hosted git repository. kszucs pushed a commit to branch maint-6.0.x in repository https://gitbox.apache.org/repos/asf/arrow.git
commit 604bf26770b695d8b31367f5876a612703addf33 Author: Joris Van den Bossche <[email protected]> AuthorDate: Thu Nov 4 22:02:24 2021 +0100 ARROW-14496: [Docs] Create relative links for R / JS / C/Glib references in the sphinx toctree using stub pages This will create dummy pages like `/r/index.html` which can be used for sphinx to link to, but which should not be added to the actual hosted files for the arrow site (they have to be overwritten by the index.html files of the respective proper doc builds for R, js and C/Glib). Closes #11601 from jorisvandenbossche/ARROW-14496-toctree-external Authored-by: Joris Van den Bossche <[email protected]> Signed-off-by: Krisztián Szűcs <[email protected]> --- docs/source/{java => c_glib}/index.rst | 16 +++------------- docs/source/index.rst | 6 +++--- docs/source/java/index.rst | 2 +- docs/source/java/{ => reference}/index.rst | 16 +++------------- docs/source/{java => js}/index.rst | 16 +++------------- docs/source/{java => r}/index.rst | 16 +++------------- 6 files changed, 16 insertions(+), 56 deletions(-) diff --git a/docs/source/java/index.rst b/docs/source/c_glib/index.rst similarity index 68% copy from docs/source/java/index.rst copy to docs/source/c_glib/index.rst index 64dd44f..56db23f 100644 --- a/docs/source/java/index.rst +++ b/docs/source/c_glib/index.rst @@ -15,17 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -Java Implementation -=================== +C/GLib docs +=========== -This is the documentation of the Java API of Apache Arrow. For more details -on the Arrow format and other language bindings see the :doc:`parent documentation <../index>`. - -.. toctree:: - :maxdepth: 2 - - vector - vector_schema_root - ipc - algorithm - Reference (javadoc) <https://arrow.apache.org/docs/java/reference/> +Stub page for the C/GLib docs; actual source is located in c_glib/doc/ sub-directory. diff --git a/docs/source/index.rst b/docs/source/index.rst index 3b92108..90d6ac0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,16 +41,16 @@ target environment.** :maxdepth: 1 :caption: Supported Environments - C/GLib <https://arrow.apache.org/docs/c_glib/> + C/GLib <c_glib/index> C++ <cpp/index> C# <https://github.com/apache/arrow/blob/master/csharp/README.md> Go <https://godoc.org/github.com/apache/arrow/go/arrow> Java <java/index> - JavaScript <https://arrow.apache.org/docs/js/> + JavaScript <js/index> Julia <https://github.com/apache/arrow/blob/master/julia/Arrow/README.md> MATLAB <https://github.com/apache/arrow/blob/master/matlab/README.md> Python <python/index> - R <https://arrow.apache.org/docs/r/> + R <r/index> Ruby <https://github.com/apache/arrow/blob/master/ruby/README.md> Rust <https://docs.rs/crate/arrow/> status diff --git a/docs/source/java/index.rst b/docs/source/java/index.rst index 64dd44f..65a7a3a 100644 --- a/docs/source/java/index.rst +++ b/docs/source/java/index.rst @@ -28,4 +28,4 @@ on the Arrow format and other language bindings see the :doc:`parent documentati vector_schema_root ipc algorithm - Reference (javadoc) <https://arrow.apache.org/docs/java/reference/> + Reference (javadoc) <reference/index> diff --git a/docs/source/java/index.rst b/docs/source/java/reference/index.rst similarity index 68% copy from docs/source/java/index.rst copy to docs/source/java/reference/index.rst index 64dd44f..523ac0c 100644 --- a/docs/source/java/index.rst +++ b/docs/source/java/reference/index.rst @@ -15,17 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -Java Implementation -=================== +Java Reference (javadoc) +======================== -This is the documentation of the Java API of Apache Arrow. For more details -on the Arrow format and other language bindings see the :doc:`parent documentation <../index>`. - -.. toctree:: - :maxdepth: 2 - - vector - vector_schema_root - ipc - algorithm - Reference (javadoc) <https://arrow.apache.org/docs/java/reference/> +Stub page for the Java reference docs; actual source is located in the java/ directory. diff --git a/docs/source/java/index.rst b/docs/source/js/index.rst similarity index 68% copy from docs/source/java/index.rst copy to docs/source/js/index.rst index 64dd44f..77813c1 100644 --- a/docs/source/java/index.rst +++ b/docs/source/js/index.rst @@ -15,17 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -Java Implementation -=================== +JavaScript docs +=============== -This is the documentation of the Java API of Apache Arrow. For more details -on the Arrow format and other language bindings see the :doc:`parent documentation <../index>`. - -.. toctree:: - :maxdepth: 2 - - vector - vector_schema_root - ipc - algorithm - Reference (javadoc) <https://arrow.apache.org/docs/java/reference/> +Stub page for the JavaScript docs; actual source is located in js/ sub-directory. diff --git a/docs/source/java/index.rst b/docs/source/r/index.rst similarity index 68% copy from docs/source/java/index.rst copy to docs/source/r/index.rst index 64dd44f..b799544 100644 --- a/docs/source/java/index.rst +++ b/docs/source/r/index.rst @@ -15,17 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -Java Implementation -=================== +R docs +====== -This is the documentation of the Java API of Apache Arrow. For more details -on the Arrow format and other language bindings see the :doc:`parent documentation <../index>`. - -.. toctree:: - :maxdepth: 2 - - vector - vector_schema_root - ipc - algorithm - Reference (javadoc) <https://arrow.apache.org/docs/java/reference/> +Stub page for the R docs; actual source is located in r/ sub-directory.
