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

[Doc] Generate Java documentation #455

Open
raulcd opened this issue Dec 11, 2024 · 3 comments
Open

[Doc] Generate Java documentation #455

raulcd opened this issue Dec 11, 2024 · 3 comments
Labels
Type: bug Something isn't working

Comments

@raulcd
Copy link
Member

raulcd commented Dec 11, 2024

Describe the bug, including details regarding any error messages, version, and platform.

As discussed on:

We should move the generation of documentation to this repository.

Quoting @lidavidm from the original issue:

IMO, we should move the Java documentation to arrow-java so it can follow the right release process. I would also like to submit for consideration the sphinx-javadoc bridge used by ADBC, which allows treating Javadoc as an Intersphinx mapping (so you don't have to hardcode links in the Sphinx source to reference Javadocs): https://github.com/apache/arrow-adbc/blob/main/docs/source/ext/doxygen_inventory.py
@raulcd raulcd added the Type: bug Something isn't working label Dec 11, 2024
This was referenced Dec 11, 2024
Closed
Merged
kou pushed a commit to apache/arrow that referenced this issue Dec 12, 2024
@raulcd
GH-44843: [CI][Doc] Remove building Java documentation from this repo…
a075bc0 
…sitory (#45000)

### Rationale for this change

Our current documentation jobs are failing to build.

### What changes are included in this PR?

Do not build Java documentation. This will be build on the arrow-java repository:
- apache/arrow-java#455

### Are these changes tested?

Yes on CI

### Are there any user-facing changes?

It shouldn't. We won't be producing the documentation here but it should be generated on the `arrow-java` repository.
* GitHub Issue: #44843

Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
@lidavidm lidavidm mentioned this issue Jan 3, 2025
Closed
@ParthChonkar ParthChonkar mentioned this issue Jan 3, 2025
Merged
@ParthChonkar
Copy link
Contributor

ParthChonkar commented Jan 3, 2025 •
edited
Loading

Was coincidentally updating Java related docs in apache/arrow in apache/arrow#45134

Happy to help if the order described in apache/arrow#45134 (comment) seems reasonable

@lidavidm
Copy link
Member

lidavidm commented Jan 3, 2025

Help would be appreciated. Honestly I think an entirely separate docs site would be appropriate. I also left some comments on docs improvements in #468 (comment).

@lidavidm
Copy link
Member

lidavidm commented Jan 3, 2025

The order you describe seems reasonable to me.

@lidavidm lidavidm mentioned this issue Jan 17, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lidavidm @raulcd @ParthChonkar