Skip to content

Commit

Permalink
GH-40441: [GLib][Docs] Use Sphinx for Apache Arrow GLib front page (#…
Browse files Browse the repository at this point in the history
…40442)

### Rationale for this change

Using both of apache/arrow and apache/arrow-site to maintain https://arrow.apache.org/docs/c_glib/  is difficult to maintain.

### What changes are included in this PR?

Use  https://github.com/apache/arrow/tree/main/docs/source/c_glib as https://arrow.apache.org/docs/c_glib/ 's source.

### Are these changes tested?

Yes.

### Are there any user-facing changes?

Yes.
* GitHub Issue: #40441

Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
  • Loading branch information
kou committed Mar 11, 2024
1 parent b171b26 commit 1eb46f7
Show file tree
Hide file tree
Showing 12 changed files with 229 additions and 24 deletions.
2 changes: 2 additions & 0 deletions ci/conda_env_sphinx.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
breathe
doxygen
ipython
linkify-it-py
myst-parser
numpydoc
pydata-sphinx-theme=0.14
sphinx-autobuild
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

breathe
ipython
myst-parser[linkify]
numpydoc
pydata-sphinx-theme~=0.14
sphinx-autobuild
Expand Down
23 changes: 23 additions & 0 deletions docs/source/c_glib/arrow-cuda-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(arrow-cuda-glib)=
# Apache Arrow CUDA GLib

Stub page for the Apache Arrow CUDA GLib docs; actual source is located in c_glib/ sub-directory.
23 changes: 23 additions & 0 deletions docs/source/c_glib/arrow-dataset-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(arrow-dataset-glib)=
# Apache Arrow Dataset GLib

Stub page for the Apache Arrow Dataset GLib docs; actual source is located in c_glib/ sub-directory.
23 changes: 23 additions & 0 deletions docs/source/c_glib/arrow-flight-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(arrow-flight-glib)=
# Apache Arrow Flight GLib

Stub page for the Apache Arrow Flight GLib docs; actual source is located in c_glib/ sub-directory.
23 changes: 23 additions & 0 deletions docs/source/c_glib/arrow-flight-sql-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(arrow-flight-sql-glib)=
# Apache Arrow Flight SQL GLib

Stub page for the Apache Arrow Flight SQL GLib docs; actual source is located in c_glib/ sub-directory.
23 changes: 23 additions & 0 deletions docs/source/c_glib/arrow-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(arrow-glib)=
# Apache Arrow GLib

Stub page for the Apache Arrow GLib docs; actual source is located in c_glib/ sub-directory.
23 changes: 23 additions & 0 deletions docs/source/c_glib/gandiva-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(gandiva-glib)=
# Gandiva GLib

Stub page for the Gandiva GLib docs; actual source is located in c_glib/ sub-directory.
42 changes: 42 additions & 0 deletions docs/source/c_glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
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)=
# Apache Arrow GLib (C)

Apache Arrow GLib is a wrapper library for Apache Arrow C++. Apache Arrow GLib provides C API.

Apache Arrow GLib supports [GObject Introspection][gobject-introspection]. It means that you can create language bindings at runtime or compile time automatically.

## API reference manuals

```{toctree}
:maxdepth: 1
Apache Arrow GLib <arrow-glib/index>
Apache Arrow CUDA GLib <arrow-cuda-glib/index>
Apache Arrow Dataset <arrow-dataset-glib/index>
Apache Arrow Flight GLib <arrow-flight-glib/index>
Apache Arrow Flight SQL GLib <arrow-flight-sql-glib/index>
Apache Parquet GLib <parquet-glib/index>
Gandiva GLib <gandiva-glib/index>
```

[gobject-introspection]: https://gi.readthedocs.io/en/latest/

23 changes: 0 additions & 23 deletions docs/source/c_glib/index.rst

This file was deleted.

23 changes: 23 additions & 0 deletions docs/source/c_glib/parquet-glib/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
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.
-->

(parquet-glib)=
# Apache Parquet GLib

Stub page for the Apache Parquet GLib docs; actual source is located in c_glib/ sub-directory.
24 changes: 23 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
'breathe',
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'myst_parser',
'numpydoc',
'sphinx_design',
'sphinx_copybutton',
Expand Down Expand Up @@ -150,6 +151,24 @@
# ipython directive options
ipython_mplbackend = ''

# MyST-Parser configuration
myst_enable_extensions = [
'amsmath',
'attrs_inline',
# 'colon_fence',
'deflist',
'dollarmath',
'fieldlist',
'html_admonition',
'html_image',
'linkify',
# 'replacements',
# 'smartquotes',
'strikethrough',
'substitution',
'tasklist',
]

# numpydoc configuration
numpydoc_xref_param_type = True
numpydoc_show_class_members = False
Expand Down Expand Up @@ -188,7 +207,10 @@
# You can specify multiple suffix as a list of string:
#

source_suffix = ['.rst']
source_suffix = {
'.md': 'markdown',
'.rst': 'restructuredtext',
}

autosummary_generate = True

Expand Down

0 comments on commit 1eb46f7

Please sign in to comment.