CASSJAVA-109, CASSJAVA-117: Manual and API References after donation, Build CI for Java Driver Doc: #2063
+883
−520
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SiyaoIsHiding
commented
Dec 9, 2025
| </dependency> | ||
| <dependency> | ||
| <groupId>com.github.spotbugs</groupId> | ||
| <artifactId>spotbugs-annotations</artifactId> |
Contributor
Author
There was a problem hiding this comment.
Need to figure out how come previously we didn't need to add those annotation dependencies?
SiyaoIsHiding
commented
Dec 11, 2025
| run: | | ||
| cp -r ../java-driver/docs ./docs/latest | ||
| mkdocs build | ||
| cp -r ./out/. . # because the index.html has to be in the root folder |
Contributor
Author
There was a problem hiding this comment.
mv instead of cp
SiyaoIsHiding
commented
Dec 11, 2025
| mvn clean install -DskipTests # or guava-shaded can not be found | ||
| # mvn javadoc:javadoc -pl core,query-builder,mapper-runtime | ||
| mvn javadoc:aggregate | ||
|
|
Contributor
Author
There was a problem hiding this comment.
add the sym links here instead of committing them
Documentation page and GitHub action
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several things this PR do:
docsof symbol links as mkdocs' working directory, and the build script "./build-doc.sh"e.g. Download the zip here. Unzip, and run this command in the root directory to preview the website:
python -m http.server(with python3).gh-pages-stagingon 4.x commit (PR merged). Example run: https://github.com/SiyaoIsHiding/java-driver/actions/runs/19521378245 (someone with write access need to create that branch first)