Experimental autodoc support.

mmcgrana · Mar 10, 2010 · b6b7ce6 · b6b7ce6
1 parent 08e0f25
commit b6b7ce6
Show file tree

Hide file tree

Showing 8 changed files with 157 additions and 1 deletion.
diff --git a/autodoc-params/templates/api-index.html b/autodoc-params/templates/api-index.html
@@ -0,0 +1,27 @@
+<h1 id="overview">Index of Public Functions and Variables in <span class="project-name-span">no project name specified</span></h1>
+
+<div class="shortcuts">
+Shortcuts:<br/>
+<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
+ <a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
+ <a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a> 
+ <a href="#M">M</a>
+<br />
+<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
+ <a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a>
+ <a href="#V">V</a> <a href="#W">W</a> <a href="#X">X</a> <a href="#Y">Y</a>
+ <a href="#Z">Z</a>
+<br />
+<a href="#Other">Other</a>
+<br />
+</div>
+
+<div id="index-body">
+  <h2><span id="section-head">A</span></h2>
+  <pre>
+<span id="section-content"> <a href="link">name</a><span id="line-content"></span </span>
+  </pre>
+</div>
+<style type="text/css">
+  #AllContentContainer {min-width: 96em;}
+</style>
diff --git a/autodoc-params/templates/layout.html b/autodoc-params/templates/layout.html
@@ -0,0 +1,53 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>Overview</title>
+    <link rel="icon" href="static/favicon.png">
+    <link rel="shortcut icon" href="static/favicon.png">
+    <link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
+    <link rel="stylesheet" href="static/wiki.css" type="text/css" media="all" />
+    <link rel="stylesheet" href="static/internal.css" type="text/css" media="all" />
+    <!-- TODO: are we using these (from clojure.org)? If so, add the files -->
+    <script type="text/javascript" src="file/view/code_highlighter.js"></script>
+    <script type="text/javascript" src="file/view/clojure.js"></script>
+    <style>.menuWrapper{height: 36px;}</style>
+    <!--[if lte IE 6]>
+    <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
+    <![endif]-->
+  </head>
+<!--
+This document was auto-generated from the source by the clojure autodoc system.
+To report errors or ask questions about the overall documentation structure, formatting,
+etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
+For errors in the documentation of a particular namespace, contact the author of that
+namespace.
+-->
+  <body>
+    <div id="AllContentContainer">
+      <div id="Header">
+	<a href="index.html" id="Logo"><img src="static/clojure-icon.gif" width="100" height="100" alt="Clojure" /></a>
+	<h1><a href="index.html" id="page-header"
+               title="page header title">Page header</a></h1>
+      </div>
+      <div id="leftcolumn"></div>
+      <div id="rightcolumn">
+	<div id="Content">
+	  <div class="contentBox"><div class="innerContentBox">
+              <div class="wiki wikiPage" id="content_view">
+                <div id="right-sidebar"></div>
+                <div id="content-tag"></div>
+              </div>
+            </div>
+          </div>
+	</div>
+	<div id="foot">
+	  <div id="copyright" style="text-align: center;">
+            Copyright 2008-2009 Rich Hickey and the various contributors
+          </div>
+	</div>
+      </div>
+      <div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
+      Clojure auto-documentation system by Tom Faulhaber.</div>
+    </div>
+    <!-- /AllContentContainer -->
+  </body>
+</html>
diff --git a/autodoc-params/templates/local-toc.html b/autodoc-params/templates/local-toc.html
@@ -0,0 +1,10 @@
+<div id="toc">
+  <h1 class="nopad">Table of Contents</h1>
+  <div class="toc-section" style="margin-left: 1em;">
+    <a href="Section anchor">Section name</a>
+    <div class="toc-entry" style="margin-left: 1em;">
+      <a href="Entry anchor">Index entry</a>
+    </div>
+    <br />
+  </div>
+</div>
diff --git a/autodoc-params/templates/master-toc.html b/autodoc-params/templates/master-toc.html
@@ -0,0 +1,11 @@
+<div style="text-align: center;"></div>
+<div class="menu">
+  <div class="WikiCustomNav WikiElement wiki">
+    <a href="index.html" class="wiki_link">Overview</a><br />
+    <a href="api-index.html" class="wiki_link">API Index</a><br />
+    <a href="#" class="wiki_link">Namespaces:</a>
+    <ul id="left-sidebar-list">
+      <li><a class="wiki_link" href="link target">Namespace short name</a></li>
+    </ul>
+  </div>
+</div>
diff --git a/autodoc-params/templates/namespace-api.html b/autodoc-params/templates/namespace-api.html
@@ -0,0 +1,13 @@
+<h1 id="overview">API for <span id="namespace-name">my-namespace</span></h1>
+<pre id="namespace-docstr">docstr here</pre>
+<div id="var-entry">
+  <br />
+  <hr />
+  <h2 id="var-tag">Var-name</h2>
+  <span id="var-type">Type goes here (var, multimethod, etc.)</span><br />
+  <pre id="var-usage">Arglists go here</pre>
+  <pre id="var-docstr">docstr here</pre>
+  <a id="var-source" href="link goes here">Source</a>
+</div>
+<div id="sub-namespaces"></div>
+
diff --git a/autodoc-params/templates/overview.html b/autodoc-params/templates/overview.html
@@ -0,0 +1,19 @@
+<h1 id="toc0">Overview of the <span id="header-project">Project</span> API</h1>
+<br />
+<div id="project-description"/>
+<br />
+<div id="namespace-entry">
+  <br />
+  <hr />
+  <h2 id="namespace-tag">Namespace</h2>
+  <a id="api-link" href="target">Detailed API documentation</a><br />
+  <pre id="namespace-docstr">docstr here</pre>
+  <span id="var-link"><a id="var-tag" href="var-tag">var-name</a> </span><br />
+  <span id="subspace"><br />Variables and functions in
+    <span id="name">subspace name</span>:
+    <span id="sub-var-link">
+      <a href="var-tag">var-name</a>
+    </span>
+    <br />
+  </span>
+</div>
diff --git a/autodoc-params/templates/sub-namespace-api.html b/autodoc-params/templates/sub-namespace-api.html
@@ -0,0 +1,10 @@
+<h2 id="namespace-name">Sub-namespace</h2>
+<pre id="namespace-docstr">docstr here</pre>
+<div id="var-entry">
+  <hr />
+  <h2 id="var-tag">Var-name</h2>
+  <span id="var-type">Type goes here (var, multimethod, etc.)</span><br />
+  <pre id="var-usage">Arglists go here</pre>
+  <pre id="var-docstr">docstr here</pre>
+  <a id="var-source" href="link goes here">Source</a>
+</div>
diff --git a/project.clj b/project.clj
@@ -5,4 +5,17 @@
                  [ring/ring-devel "0.2.0-SNAPSHOT"]
                  [ring/ring-httpcore-adapter "0.2.0-SNAPSHOT"]
                  [ring/ring-jetty-adapter "0.2.0-SNAPSHOT"]
-                 [ring/ring-servlet "0.2.0-SNAPSHOT"]])
+                 [ring/ring-servlet "0.2.0-SNAPSHOT"]]
+  :dev-dependencies [[autodoc "0.7.0"]]
+  :autodoc
+    {:name "Ring"
+     :description "A Clojure web applications library"
+     :copyright "Copyright 2009-2010 Mark McGranaghan"
+     :root "."
+     :source-path ""
+     :web-src-dir "http://github.com/mmcgrana/ring/blob/"
+     :web-home "http://mmcgrana.github.com/ring/"
+     :output-path "/Users/mmcgrana/Desktop/ring-autodoc"
+     :namespaces-to-document ["ring"]
+     :trim-prefix "ring."
+     :load-except-list [#"/example/" #"/test/" #"project\.clj"]})