From 5ba8c80f951d4a750d1a317443390161d48c759d Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 4 Nov 2021 09:26:19 +0100 Subject: [PATCH 1/4] ARROW-14496: [Docs] Create relative links for R / JS / C/Glib references in the sphinx toctree using stub pages --- docs/source/c_glib/index.rst | 21 +++++++++++++++++++++ docs/source/index.rst | 6 +++--- docs/source/js/index.rst | 21 +++++++++++++++++++++ docs/source/r/index.rst | 21 +++++++++++++++++++++ 4 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 docs/source/c_glib/index.rst create mode 100644 docs/source/js/index.rst create mode 100644 docs/source/r/index.rst diff --git a/docs/source/c_glib/index.rst b/docs/source/c_glib/index.rst new file mode 100644 index 00000000000..d2b837d8690 --- /dev/null +++ b/docs/source/c_glib/index.rst @@ -0,0 +1,21 @@ +.. 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. + +C/Glib stub page +================ + +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 3b921082a22..90d6ac09ba2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,16 +41,16 @@ target environment.** :maxdepth: 1 :caption: Supported Environments - C/GLib + C/GLib C++ C# Go Java - JavaScript + JavaScript Julia MATLAB Python - R + R Ruby Rust status diff --git a/docs/source/js/index.rst b/docs/source/js/index.rst new file mode 100644 index 00000000000..da1e9c87161 --- /dev/null +++ b/docs/source/js/index.rst @@ -0,0 +1,21 @@ +.. 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. + +JS stub page +=========== + +Stub page for the JavaScript docs; actual source is located in js/ sub-directory. diff --git a/docs/source/r/index.rst b/docs/source/r/index.rst new file mode 100644 index 00000000000..d8d2c0e0422 --- /dev/null +++ b/docs/source/r/index.rst @@ -0,0 +1,21 @@ +.. 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. + +R stub page +=========== + +Stub page for the R docs; actual source is located in r/ sub-directory. From a6b55e465024f43f77f71f99fd9c947cb4c11dc7 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 4 Nov 2021 09:29:48 +0100 Subject: [PATCH 2/4] update titles --- docs/source/c_glib/index.rst | 4 ++-- docs/source/js/index.rst | 4 ++-- docs/source/r/index.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/c_glib/index.rst b/docs/source/c_glib/index.rst index d2b837d8690..9e95872025d 100644 --- a/docs/source/c_glib/index.rst +++ b/docs/source/c_glib/index.rst @@ -15,7 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -C/Glib stub page -================ +C/Glib docs +=========== Stub page for the C/Glib docs; actual source is located in c_glib/doc/ sub-directory. diff --git a/docs/source/js/index.rst b/docs/source/js/index.rst index da1e9c87161..77813c1372d 100644 --- a/docs/source/js/index.rst +++ b/docs/source/js/index.rst @@ -15,7 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -JS stub page -=========== +JavaScript docs +=============== Stub page for the JavaScript docs; actual source is located in js/ sub-directory. diff --git a/docs/source/r/index.rst b/docs/source/r/index.rst index d8d2c0e0422..b799544bb6b 100644 --- a/docs/source/r/index.rst +++ b/docs/source/r/index.rst @@ -15,7 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -R stub page -=========== +R docs +====== Stub page for the R docs; actual source is located in r/ sub-directory. From 081040a446faa18dfb5f4f9ab78e1fda733b6f7c Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 4 Nov 2021 09:30:47 +0100 Subject: [PATCH 3/4] correct glib spelling --- docs/source/c_glib/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/c_glib/index.rst b/docs/source/c_glib/index.rst index 9e95872025d..56db23f2a20 100644 --- a/docs/source/c_glib/index.rst +++ b/docs/source/c_glib/index.rst @@ -15,7 +15,7 @@ .. specific language governing permissions and limitations .. under the License. -C/Glib docs +C/GLib docs =========== -Stub page for the C/Glib docs; actual source is located in c_glib/doc/ sub-directory. +Stub page for the C/GLib docs; actual source is located in c_glib/doc/ sub-directory. From ad6e262b04c4f707c3a306193713743744c1dc68 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 4 Nov 2021 17:19:38 +0100 Subject: [PATCH 4/4] add java reference as well --- docs/source/java/index.rst | 2 +- docs/source/java/reference/index.rst | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/source/java/reference/index.rst diff --git a/docs/source/java/index.rst b/docs/source/java/index.rst index 64dd44f080b..65a7a3a4f10 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) + Reference (javadoc) diff --git a/docs/source/java/reference/index.rst b/docs/source/java/reference/index.rst new file mode 100644 index 00000000000..523ac0c7f74 --- /dev/null +++ b/docs/source/java/reference/index.rst @@ -0,0 +1,21 @@ +.. 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. + +Java Reference (javadoc) +======================== + +Stub page for the Java reference docs; actual source is located in the java/ directory.