[jira] [Comment Edited] (MAHOUT-1562) Publish Scaladocs

["Stevo Slavic (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MAHOUT-1562?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14491451#comment-14491451 ] 

Stevo Slavic edited comment on MAHOUT-1562 at 4/12/15 12:37 PM:
----------------------------------------------------------------

In 0.10.0 scaladoc jars are published on maven central repo (e.g. see [mahout-math-scala_2.10-0.10.0-javadoc.jar|http://repo1.maven.org/maven2/org/apache/mahout/mahout-math-scala_2.10/0.10.0/mahout-math-scala_2.10-0.10.0-javadoc.jar])
Also docs directory of Mahout 0.10.0 binary distribution archives (like [tarball dist archive|http://repo1.maven.org/maven2/org/apache/mahout/mahout-distribution/0.10.0/mahout-distribution-0.10.0.tar.gz]) contains scaladoc and javadoc of all modules.
This is most we could do with Maven.

What remains to be done, as part of migration to sbt (see MAHOUT-1654), is to have Mahout-Quality javadoc site to be [unidoc|https://github.com/sbt/sbt-unidoc] of all (java and scala) sources.


was (Author: sslavic):
In 0.10.0 scaladoc jars are published on maven central repo (e.g. see [mahout-math-scala_2.10-0.10.0-javadoc.jar|http://repo1.maven.org/maven2/org/apache/mahout/mahout-math-scala_2.10/0.10.0/mahout-math-scala_2.10-0.10.0-javadoc.jar])
Also [in docs directory of Mahout 0.10.0 binary distribution archive|http://repo1.maven.org/maven2/org/apache/mahout/mahout-distribution/0.10.0/mahout-distribution-0.10.0.tar.gz] contains scaladoc and javadoc of all modules.
This is most we could do with Maven.

What remains to be done, as part of migration to sbt (see MAHOUT-1654), is to have Mahout-Quality javadoc site to be [unidoc|https://github.com/sbt/sbt-unidoc] of all (java and scala) sources.

> Publish Scaladocs
> -----------------
>
>                 Key: MAHOUT-1562
>                 URL: https://issues.apache.org/jira/browse/MAHOUT-1562
>             Project: Mahout
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: Pat Ferrel
>            Assignee: Stevo Slavic
>            Priority: Minor
>              Labels: DSL, scala, scaladocs, spark, spark-shell
>             Fix For: 0.10.0
>
>
> The poms that relate to Scala have the maven-scala-plugin, which will generate Scaladocs if you navigate to the scala subproject and run
> mvn scala:doc
> They will appear in target/site/scaladocs for the subproject.
> This is not supported from the parent mahout pom
> This should be incorporated into the process that publishes the javadocs. It appears the Scala code is not publically browsable as Scaladocs. Not sure where this process lives but the scala stuff should probably follow that same pattern/process as javadocs



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)