aboutsummaryrefslogtreecommitdiff
path: root/docs/api.md
Commit message (Collapse)AuthorAgeFilesLines
* [SPARK-1439, SPARK-1440] Generate unified Scaladoc across projects and JavadocsMatei Zaharia2014-04-211-8/+5
| | | | | | | | | | | | | | | | | | | | | | 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/ Author: Matei Zaharia <matei@databricks.com> This patch had conflicts when merged, resolved by Committer: Patrick Wendell <pwendell@gmail.com> Closes #457 from mateiz/better-docs and squashes the following commits: a63d4a3 [Matei Zaharia] Skip Java/Scala API docs for Python package 5ea1f43 [Matei Zaharia] Fix links to Java classes in Java guide, fix some JS for scrolling to anchors on page load f05abc0 [Matei Zaharia] Don't include java.lang package names 995e992 [Matei Zaharia] Skip internal packages and class names with $ in JavaDoc a14a93c [Matei Zaharia] typo 76ce64d [Matei Zaharia] Add groups to Javadoc index page, and a first package-info.java ed6f994 [Matei Zaharia] Generate JavaDoc as well, add titles, update doc site to use unified docs acb993d [Matei Zaharia] Add Unidoc plugin for the projects we want Unidoced
* Soften wording about GraphX superseding BagelAnkur Dave2014-01-101-1/+1
|
* Add back Bagel links to docs, but mark them supersededAnkur Dave2014-01-101-1/+2
|
* Merge branch 'master' into streamingTathagata Das2013-01-151-0/+1
|\ | | | | | | | | | | | | | | | | Conflicts: core/src/main/scala/spark/rdd/CoGroupedRDD.scala core/src/main/scala/spark/rdd/FilteredRDD.scala docs/_layouts/global.html docs/index.md run
| * Add documentation for Python API.Josh Rosen2012-12-281-0/+1
| |
* | Updated Streaming Programming Guide.Tathagata Das2013-01-011-2/+3
|/
* Adds liquid variables to docs templating system so that they can be usedAndy Konwinski2012-10-081-3/+3
| | | | | | | | | throughout the docs: SPARK_VERSION, SCALA_VERSION, and MESOS_VERSION. To use them, e.g. use {{site.SPARK_VERSION}}. Also removes uses of {{HOME_PATH}} which were being resolved to "" by the templating system anyway.
* More updates to documentationMatei Zaharia2012-09-251-4/+3
|
* Adds a jekyll plugin (written in Ruby) to the _plugins directoryAndy Konwinski2012-09-131-4/+4
| | | | | | | which generates scala doc by calling `sbt/sbt doc`, copies it over to docs, and updates the links from the api webpage to now point to the copied over scaladoc (making the _site directory easy to just copy over to a public website).
* Making the link to api scaladocs work and migrating other code snippetsAndy Konwinski2012-09-121-0/+11
to use pygments syntax highlighting.
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-01 00:08:09 +0000