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.

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

[jvm-packages] Scaladoc issues with 2.12 #4779

Open
thesuperzapper opened this issue Aug 16, 2019 · 4 comments
Open

[jvm-packages] Scaladoc issues with 2.12 #4779

thesuperzapper opened this issue Aug 16, 2019 · 4 comments

Comments

@thesuperzapper
Copy link
Contributor

As we are moving to Scala 2.12 exclusivly, I can see we have moved to the new Scaladoc, however there seems to be something wrong, as the new layout is significantly harder to use.

XGBoost4j Docs: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j/index.html
XGBoost4j-spark Docs: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j-spark/index.html

Both of which are not very usefull because they hide all classes behind 5+ clicks, for example:
image

Perhaps we could link deeper into the classpath (from the xgboost.ai site), or change something else about how we are using Scaladoc with 2.12?

Deeper link example: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j-spark/ml/dmlc/xgboost4j/scala/spark/index.html

@hcho3
Copy link
Collaborator

hcho3 commented Aug 16, 2019

Is it possible to use older theme for the doc? I liked the old theme a lot better.

@CodingCat @trams

@trams
Copy link
Contributor

trams commented Aug 16, 2019

A agree that having to click 5 times to get to any of the classes is not good.
I would gladly help but I know nothing about how we generate scaladoc in xgboost. If someone could get pointers I may help

@hcho3
Copy link
Collaborator

hcho3 commented Aug 16, 2019

@trams Here is the script we run to generate scaladoc:

# Install JVM packages in local Maven repository
mvn --no-transfer-progress install -DskipTests
# Build Scaladocs
mvn --no-transfer-progress scala:doc -DskipTests
# Build Javadocs
mvn --no-transfer-progress javadoc:javadoc -DskipTests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants