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.

Sign up for GitHub

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

Jump to bottom

[GLib][Docs] Use Sphinx for Apache Arrow GLib front page #40441

Closed
kou opened this issue Mar 10, 2024 · 1 comment
Closed

[GLib][Docs] Use Sphinx for Apache Arrow GLib front page #40441

kou opened this issue Mar 10, 2024 · 1 comment
Assignees
@kou
Labels
Component: Documentation Component: GLib Type: enhancement
Milestone
16.0.0

Comments

@kou
Copy link
Member

kou commented Mar 10, 2024 •
edited
Loading

Describe the enhancement requested

We use https://github.com/apache/arrow-site/blob/main/_docs/c_glib/index.md as the source of https://arrow.apache.org/docs/c_glib/ . It's difficult to maintain because we use this repository for https://arrow.apache.org/docs/ .

We can use only apache/arrow to maintain https://arrow.apache.org/docs/c_glib/ by using https://github.com/apache/arrow/tree/main/docs/source/c_glib as its source.

Component(s)

Documentation, GLib
kou added a commit to kou/arrow that referenced this issue Mar 10, 2024
@kou
apacheGH-40441: [GLib][Docs] Use Sphinx for Apache Arrow GLib front page
1d32a42
@github-actions github-actions bot mentioned this issue Mar 10, 2024
Merged
kou added a commit that referenced this issue Mar 11, 2024
@kou
GH-40441: [GLib][Docs] Use Sphinx for Apache Arrow GLib front page (#…
1eb46f7 
…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>
@kou kou added this to the 16.0.0 milestone Mar 11, 2024
@kou
Copy link
Member Author

kou commented Mar 11, 2024

Issue resolved by pull request 40442
#40442

@kou kou closed this as completed Mar 11, 2024
kou added a commit to kou/arrow-site that referenced this issue Mar 16, 2024
@kou
Don't generate C GLib front page
460b2f3 
Because it's generated by Sphinx now.
See also: apache/arrow#40441
@kou kou mentioned this issue Mar 16, 2024
Merged
kou added a commit to apache/arrow-site that referenced this issue Mar 18, 2024
@kou
Don't generate C GLib front page (#485)
2b52db2 
Because it's generated by Sphinx now.
See also: apache/arrow#40441
@kou kou mentioned this issue Apr 26, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kou kou

Labels
Component: Documentation Component: GLib Type: enhancement
Projects
None yet
Milestone
16.0.0
Development

No branches or pull requests
1 participant
@kou