Source

hh-web-tags / documentation.lisp

;; Copyright (c) 2011 Phil Hargett

;; Permission is hereby granted, free of charge, to any person obtaining a copy
;; of this software and associated documentation files (the "Software"), to deal
;; in the Software without restriction, including without limitation the rights
;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
;; copies of the Software, and to permit persons to whom the Software is
;; furnished to do so, subject to the following conditions:

;; The above copyright notice and this permission notice shall be included in
;; all copies or substantial portions of the Software.

;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
;; THE SOFTWARE.

(in-package :hh-web-tags)


(deftemplates :tag-library-packages ( "hh-web-tags")
  :template-packages ( "hh-web-tags")
  :templates ((doc-index "doc_index.lisp"))
  :template-folder "doctemplates"
  :tag-library-folder "doctaglibraries")

(defun generate-package-documentation ()
  (flet ((report (&rest args)
	   (apply #'format *standard-output* args)))
    (let* ((documentation-path (asdf:system-relative-pathname 
				(asdf:find-system :hh-web-tags) 
				(make-pathname :directory `(:relative "docs"))))
	   (index-path (merge-pathnames (make-pathname :name "index" :type "html")
					(make-pathname :host (pathname-host documentation-path)
						       :directory (pathname-directory documentation-path)))))
      (report "Generating documentation to directory ~s~%" documentation-path)
      (ensure-directories-exist documentation-path)
      (with-open-file (os index-path :direction :output :if-does-not-exist :create :if-exists :supersede)
	(report "Generating index at ~s~%" index-path)
	(write-string (doc-index) os))))
  t)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.