Skip to content

Conversation

@Subham-KRLX
Copy link
Contributor

Did you read the Contributor Guide?
Yes, I have read the Contributor Rules and Contributor Development Guide
No, I haven't read it.
Is this PR related to a ticket?
Yes, and the PR name follows the format [GH-1893] Fix JavaDoc package-list error in docs build workflow. Closes #1893
No:
this is a documentation update. The PR name follows the format [DOCS] my subject
this is a CI update. The PR name follows the format [CI] my subject
What changes were proposed in this PR?
This PR fixes the JavaDoc build error reported in issue #1893, where the build failed with Error fetching link: .../common/target/target/apidocs/package-list.

The issue was caused by the spark/common module trying to link to the common module's JavaDoc, but the common module's JavaDoc was not being copied to the documentation directory in the GitHub Actions workflow.

This patch updates the .github/workflows/docs.yml file to explicitly copy the common module's generated JavaDoc to docs/api/javadoc/common/. This ensures the package-list file exists at the expected location for linking.

How was this patch tested?
Verified the workflow syntax and path logic.
Ran mvn -q clean install -DskipTests locally to ensure the build process works.
The CI build for this PR will serve as the final verification.
Did this PR include necessary documentation updates?
Yes, I am adding a new API. I am using the current SNAPSHOT version number in vX.Y.Z format.
Yes, I have updated the documentation.
No, this PR does not affect any public API so no need to change the documentation.

Implements Material theme palette toggle with three modes:
- Automatic mode (follows system preference)
- Light mode (default scheme)
- Dark mode (slate scheme)

Users can now toggle between themes using the icon in the header.
All modes preserve the existing deep orange primary and green accent colors.

Closes apache#2444
@github-actions github-actions bot removed the root label Nov 21, 2025
@Subham-KRLX
Copy link
Contributor Author

Subham-KRLX commented Nov 25, 2025

@jiayuasu please check this out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

gha: docs build Compile JavaDoc step error message

1 participant