Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARROW-14496: [Docs] Create relative links for R / JS / C/Glib references in the sphinx toctree using stub pages #11601

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/c_glib/index.rst
Original file line number Diff line number Diff line change
@@ -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 docs
===========

Stub page for the C/GLib docs; actual source is located in c_glib/doc/ sub-directory.
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/java/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>
21 changes: 21 additions & 0 deletions docs/source/java/reference/index.rst
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 21 additions & 0 deletions docs/source/js/index.rst
Original file line number Diff line number Diff line change
@@ -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.

JavaScript docs
===============

Stub page for the JavaScript docs; actual source is located in js/ sub-directory.
21 changes: 21 additions & 0 deletions docs/source/r/index.rst
Original file line number Diff line number Diff line change
@@ -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 docs
======

Stub page for the R docs; actual source is located in r/ sub-directory.