generate-documentation.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; package: cl-user -*-
   2 ;;;; **************************************************************************************
   3 ;;;;
   4 ;;;; (c) 2008 Utz-Uwe Haus, <lisp@uuhaus.de>
   5 ;;;;
   6 ;;;; $Id$
   7 ;;;;
   8 ;;;; This code is free software; you can redistribute it and/or modify
   9 ;;;; it under the terms of the version 3 of the GNU General
  10 ;;;; Public License as published by the Free Software Foundation, as
  11 ;;;; clarified by the prequel found in LICENSE.Lisp-GPL-Preface.
  12 ;;;;
  13 ;;;; This code is distributed in the hope that it will be useful, but
  14 ;;;; without any warranty; without even the implied warranty of
  15 ;;;; merchantability or fitness for a particular purpose. See the GNU
  16 ;;;; Lesser General Public License for more details.
  17 ;;;;
  18 ;;;; Version 3 of the GNU General Public License is in the file
  19 ;;;; LICENSE.GPL that was distributed with this file. If it is not
  20 ;;;; present, you can access it from
  21 ;;;; http://www.gnu.org/copyleft/gpl.txt (until superseded by a
  22 ;;;; newer version) or write to the Free Software Foundation, Inc., 59
  23 ;;;; Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24 ;;;;
  25 ;;;; **************************************************************************************
  26
  27 ;;; Load this file to generate documentation using David Lichteblau's atdoc
  28 ;;; (if you are adventurous add this file to the .asd file as depending on
  29 ;;;  the package itself)
  30 (asdf:oos 'asdf:load-op 'atdoc)
  31 ;; we force a fresh compile-and-load cycle to make sure docstrings
  32 ;; are up-to-date
  33 ;; ugly: package docstring is not updated on allegro unless we
  34 (ignore-errors (delete-package :opossum))
  35
  36 (asdf:oos 'asdf:compile-op 'opossum :force T)
  37 (asdf:oos 'asdf:load-op 'opossum :force T)
  38
  39
  40 (in-package :cl-user)
  41
  42 (atdoc:generate-documentation '(:OPOSSUM)
  43                               (directory-namestring
  44                                (make-pathname
  45                                 :directory (append
  46                                             (pathname-directory
  47                                              (asdf:system-definition-pathname
  48                                               (asdf:find-system :opossum)))
  49                                             '("web"))))
  50                               :index-title "OPOSSUM reference manual"
  51                               :heading "opossum"
  52                               :css "boxy.css")