dmlc / xgboost

Scalable, Portable and Distributed Gradient Boosting (GBDT, GBRT or GBM) Library, for Python, R, Java, Scala, C++ and more. Runs on single machine, Hadoop, Spark, Dask, Flink and DataFlow
https://xgboost.readthedocs.io/en/stable/
Apache License 2.0
26.28k stars 8.73k forks source link

[jvm-packages] Scaladoc issues with 2.12 #4779

Open thesuperzapper opened 5 years ago

thesuperzapper commented 5 years ago

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 commented 5 years ago

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

@CodingCat @trams

trams commented 5 years ago

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 commented 5 years ago

@trams Here is the script we run to generate scaladoc: https://github.com/dmlc/xgboost/blob/b9b57f228939d289098d81a34f28bd696f156b4e/tests/ci_build/build_jvm_doc.sh#L19-L24

CodingCat commented 5 years ago

comparing to scala's own doc https://www.scala-lang.org/api/current/

I think a quick fix is to provide a rootdoc.txt https://github.com/scala/scala/blob/1e904d75450373d7845eb7452d940e52d955b27d/src/library/rootdoc.txt

https://stackoverflow.com/questions/53566250/how-do-i-configure-maven-to-use-rootdoc-txt-in-scaladoc-report