SiyaoIsHiding commented on code in PR #2063: URL: https://github.com/apache/cassandra-java-driver/pull/2063#discussion_r3088013174
########## build-doc.sh: ########## @@ -0,0 +1,16 @@ +set -e +# Set up python environment +#pyenv local 3.10.1 +#pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin + +# In some bash/zsh environments, the locale is not set correctly, which causes mkdocs to fail. +export LC_ALL=en_US.UTF-8 +export LANG=en_US.UTF-8 + +# Build Javadoc +mvn clean install -DskipTests # or guava-shaded can not be found +# mvn javadoc:javadoc -pl core,query-builder,mapper-runtime +mvn javadoc:aggregate + Review Comment: At one point we were saying to add the sym links here and remove them at the end of the build script to avoid commiting those sym links. Bret and I discussed again this morning. We think committing those sym links do not bring a big problem. And leaving those symbol links here enables the future doc developers to simply run `mkdocs build` command without adding and removing symbol links. So we prefer leaving those sym links here as it is. What do you think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]

