diff options
author | Matei Zaharia <matei@databricks.com> | 2014-04-21 21:57:40 -0700 |
---|---|---|
committer | Patrick Wendell <pwendell@gmail.com> | 2014-04-21 21:57:40 -0700 |
commit | fc7838470465474f777bd17791c1bb5f9c348521 (patch) | |
tree | 6809dfd66ebafa6dced2018585a3a1f9ba270d53 /docs/_layouts/global.html | |
parent | 04c37b6f749dc2418cc28c89964cdc687dfcbd51 (diff) | |
download | spark-fc7838470465474f777bd17791c1bb5f9c348521.tar.gz spark-fc7838470465474f777bd17791c1bb5f9c348521.tar.bz2 spark-fc7838470465474f777bd17791c1bb5f9c348521.zip |
[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/
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
Diffstat (limited to 'docs/_layouts/global.html')
-rwxr-xr-x | docs/_layouts/global.html | 105 |
1 files changed, 18 insertions, 87 deletions
diff --git a/docs/_layouts/global.html b/docs/_layouts/global.html index 5d4dbb7a9c..8b543de574 100755 --- a/docs/_layouts/global.html +++ b/docs/_layouts/global.html @@ -76,32 +76,9 @@ <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a> <ul class="dropdown-menu"> - <li><a href="api/core/index.html#org.apache.spark.package">Spark Core for Java/Scala</a></li> - <li><a href="api/pyspark/index.html">Spark Core for Python</a></li> - <li class="divider"></li> - <li><a href="api/streaming/index.html#org.apache.spark.streaming.package">Spark Streaming</a></li> - <li class="dropdown-submenu"> - <a tabindex="-1" href="#">Spark SQL</a> - <ul class="dropdown-menu"> - <li><a href="api/sql/core/org/apache/spark/sql/SQLContext.html">Spark SQL Core</a></li> - <li><a href="api/sql/hive/org/apache/spark/sql/hive/package.html">Hive Support</a></li> - <li><a href="api/sql/catalyst/org/apache/spark/sql/catalyst/package.html">Catalyst (Optimization)</a></li> - </ul> - </li> - <li><a href="api/mllib/index.html#org.apache.spark.mllib.package">MLlib (Machine Learning)</a></li> - <li><a href="api/bagel/index.html#org.apache.spark.bagel.package">Bagel (Pregel on Spark)</a></li> - <li><a href="api/graphx/index.html#org.apache.spark.graphx.package">GraphX (Graph Processing)</a></li> - <li class="divider"></li> - <li class="dropdown-submenu"> - <a tabindex="-1" href="#">External Data Sources</a> - <ul class="dropdown-menu"> - <li><a href="api/external/kafka/index.html#org.apache.spark.streaming.kafka.KafkaUtils$">Kafka</a></li> - <li><a href="api/external/flume/index.html#org.apache.spark.streaming.flume.FlumeUtils$">Flume</a></li> - <li><a href="api/external/twitter/index.html#org.apache.spark.streaming.twitter.TwitterUtils$">Twitter</a></li> - <li><a href="api/external/zeromq/index.html#org.apache.spark.streaming.zeromq.ZeroMQUtils$">ZeroMQ</a></li> - <li><a href="api/external/mqtt/index.html#org.apache.spark.streaming.mqtt.MQTTUtils$">MQTT</a></li> - </ul> - </li> + <li><a href="api/scala/index.html#org.apache.spark.package">Scaladoc</a></li> + <li><a href="api/java/index.html">Javadoc</a></li> + <li><a href="api/python/index.html">Python API</a></li> </ul> </li> @@ -140,33 +117,6 @@ <h1 class="title">{{ page.title }}</h1> {{ content }} - <!-- Main hero unit for a primary marketing message or call to action --> - <!--<div class="hero-unit"> - <h1>Hello, world!</h1> - <p>This is a template for a simple marketing or informational website. It includes a large callout called the hero unit and three supporting pieces of content. Use it as a starting point to create something more unique.</p> - <p><a class="btn btn-primary btn-large">Learn more »</a></p> - </div>--> - - <!-- Example row of columns --> - <!--<div class="row"> - <div class="span4"> - <h2>Heading</h2> - <p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p> - <p><a class="btn" href="#">View details »</a></p> - </div> - <div class="span4"> - <h2>Heading</h2> - <p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p> - <p><a class="btn" href="#">View details »</a></p> - </div> - <div class="span4"> - <h2>Heading</h2> - <p>Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</p> - <p><a class="btn" href="#">View details »</a></p> - </div> - </div> - - <hr>--> </div> <!-- /container --> @@ -174,42 +124,23 @@ <script src="js/vendor/bootstrap.min.js"></script> <script src="js/main.js"></script> - <!-- A script to fix internal hash links because we have an overlapping top bar. - Based on https://github.com/twitter/bootstrap/issues/193#issuecomment-2281510 --> + <!-- MathJax Section --> + <script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + TeX: { equationNumbers: { autoNumber: "AMS" } } + }); + </script> + <script type="text/javascript" + src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script> - $(function() { - function maybeScrollToHash() { - if (window.location.hash && $(window.location.hash).length) { - var newTop = $(window.location.hash).offset().top - $('#topbar').height() - 5; - $(window).scrollTop(newTop); - } + MathJax.Hub.Config({ + tex2jax: { + inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], + displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], + processEscapes: true, + skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'] } - $(window).bind('hashchange', function() { - maybeScrollToHash(); - }); - // Scroll now too in case we had opened the page on a hash, but wait 1 ms because some browsers - // will try to do *their* initial scroll after running the onReady handler. - setTimeout(function() { maybeScrollToHash(); }, 1) - }) + }); </script> - </body> - <!-- MathJax Section --> - <script type="text/x-mathjax-config"> - MathJax.Hub.Config({ - TeX: { equationNumbers: { autoNumber: "AMS" } } - }); - </script> - <script type="text/javascript" - src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> - <script> - MathJax.Hub.Config({ - tex2jax: { - inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], - displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], - processEscapes: true, - skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'] - } - }); - </script> </html> |