GitHub user mateiz opened a pull request:
https://github.com/apache/spark/pull/457
[SPARK-1439, SPARK-1440] Generate unified Scaladoc across projects and
Javadocs
I used the sbt-unidoc plugin (https://github.com/sbt/sbt-unidoc) to create
a unified Scaladoc of our public packages, and generate Javadocs as well. One
limitation is that I haven't found an easy way to exclude packages in the
Javadoc; there is a SBT task that identifies Java sources to run javadoc on,
but it's been very difficult to modify it from outside to change what is set in
the unidoc package. Some SBT-savvy people should help with this. The Javadoc
site also lacks package-level descriptions and things like that, so we may want
to look into that. We may decide not to post these right now if it's too
limited compared to the Scala one.
Example of the built doc site:
http://people.csail.mit.edu/matei/spark-unified-docs/
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/mateiz/spark better-docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/457.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #457
----
commit acb993df92365780291d646a7dbd0b68ae361f64
Author: Matei Zaharia <[email protected]>
Date: 2014-04-19T22:49:22Z
Add Unidoc plugin for the projects we want Unidoced
commit ed6f994be376300fa8ed8706110d57862daaf6d9
Author: Matei Zaharia <[email protected]>
Date: 2014-04-20T18:55:50Z
Generate JavaDoc as well, add titles, update doc site to use unified docs
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
