Support for generating docsets; release 3.0.0

tsdh · Mar 2, 2015 · 74d18e6 · 74d18e6
1 parent d44d6cd
commit 74d18e6
Show file tree

Hide file tree

Showing 4 changed files with 185 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,9 @@ want to add to your project's `project.clj`:
 
 ```
 :html5-docs-docs-dir            ;; Optional: where to put the HTML files.  Defaults to "docs".
-:html5-docs-name "FooBar"       ;; Optional: if specified, overrides the project :name
+:html5-docs-name                ;; Optional: if specified, overrides the project :name
+:html5-docs-docset-icons        ;; Optional: A vector of two png icons for use in the generated docset.
+                                ;; the first should be 16x16, the second 32x32.  The latter is optional.
 :html5-docs-page-title          ;; Optional: defaults to "<ProjectName> API Documentation"
 :html5-docs-source-path         ;; Optional: overrides :source-path, handy if you want to document only
                                 ;; src/foo, but not src/bar, src/baz, ...

diff --git a/project.clj b/project.clj
@@ -1,10 +1,12 @@
 ;; TODO: When bumping the version number here, be sure to bump it also in
 ;; src/leiningen/html5_docs/core.clj (var lein-html5-docs-version).
-(defproject lein-html5-docs "2.2.0"
-  :description "A HTML5 API docs generator plugin for Leiningen.
-Versions below 1.2.0 are for Leiningen 1, starting with 1.2.0 Leiningen 2 is
-required."
-  :dependencies [[hiccup "1.0.5"]]
+(defproject lein-html5-docs "3.0.0"
+  :description "A HTML5 API docs generator plugin for Leiningen.  Also
+generates docsets for use with Dash (http://kapeli.com/dash) and
+Zeal (http://zealdocs.org/)."
+  :dependencies [[hiccup "1.0.5"]
+                 [org.clojure/java.jdbc "0.3.6"]
+                 [org.xerial/sqlite-jdbc "3.8.7"]]
   :jar-exclusions [#"(?:^|/).git/"]
   :global-vars {*warn-on-reflection* true}
   :eval-in-leiningen true

diff --git a/src/leiningen/html5_docs.clj b/src/leiningen/html5_docs.clj
@@ -3,9 +3,9 @@
   (:use [leiningen.core.eval :only [eval-in-project]])
   (:use [leiningen.html5-docs.core :only [lein-html5-docs-version]]))
 
-(defn html5-docs [project]
+(defn html5-docs [project & args]
   (eval-in-project
    (update-in project [:dependencies]
               conj ['lein-html5-docs lein-html5-docs-version])
-   `(leiningen.html5-docs.core/html5-docs '~project)
+   `(leiningen.html5-docs.core/html5-docs '~project '~@args)
    '(require 'leiningen.html5-docs.core)))