From 6573fd54dde14d4a623fa5e7ad2199f1c09e2cf7 Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Fri, 2 May 2014 15:19:54 -0400 Subject: [PATCH] Remove old HTML doc generation. Quickdocs or the Markdown documentation are preferrable. --- docs/coleslaw.html | 186 --------------------------------------------- gen-docs.sh | 4 - 2 files changed, 190 deletions(-) delete mode 100644 docs/coleslaw.html delete mode 100755 gen-docs.sh diff --git a/docs/coleslaw.html b/docs/coleslaw.html deleted file mode 100644 index c04f50b..0000000 --- a/docs/coleslaw.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - -API for COLESLAW - - - -
-
API for package: -coleslaw
-
-
Homepage: Github
-
-
--Variables
-
-
-
-*config*: -NIL -variable
-
-
A variable to store the blog configuration and plugin settings.
-
-
--Classes
-
-
-
-content -(standard-object) -class
-
-

-

-

-index
-(standard-object)
-class

-

-

-

-
SLOTS

-content
-

-
UNDOCUMENTED

-

-

-post
-(content)
-class

-

-

-

-

--Functions

-

-

-

-add-document
-doc
-function

-

-
Add DOC to the in-memory database. Error if a matching entry is present.

-

-

-add-injection
-injection location
-function

-

-
Adds an INJECTION to a given LOCATION for rendering. The INJECTION should be
-a string which will always be added or a (string . lambda). In the latter case,
-the lambda takes a single argument, a content object, i.e. a POST or INDEX, and
-any return value other than nil indicates the injection should be added.

-

-

-discover
-doc-type
-standard-generic-function

-

-
Load all documents of the given DOC-TYPE into memory.

-

-

-find-all
-doc-type
-function

-

-
Return a list of all instances of a given DOC-TYPE.

-

-

-main
-&optional config-key
-function

-

-
Load the user's config file, then compile and deploy the site.

-

-

-page-url
-document
-standard-generic-function

-

-
The url to the document, without the domain.

-

-

-preview
-path &optional (content-type 'post)
-function

-

-
Render the content at PATH under user's configured repo and save it to
-~/tmp.html. Load the user's config and theme if necessary.

-

-

-publish
-doc-type
-standard-generic-function

-

-
Write pages to disk for all documents of the given DOC-TYPE.

-

-

-purge-all
-doc-type
-function

-

-
Remove all instances of DOC-TYPE from memory.

-

-

-render
-document &key next prev &allow-other-keys
-standard-generic-function

-

-
Render the given DOCUMENT to HTML.

-

-

-render-text
-text format
-standard-generic-function

-

-
Render TEXT of the given FORMAT to HTML for display.

-
Generated by: 
-CL-API

\ No newline at end of file
diff --git a/gen-docs.sh b/gen-docs.sh
deleted file mode 100755
index d210802..0000000
--- a/gen-docs.sh
+++ /dev/null
@@ -1,4 +0,0 @@
-#!/bin/sh
-sbcl --eval "(ql:quickload '(coleslaw sb-introspect cl-api))" \
-     --eval "(cl-api:api-gen :coleslaw \"docs/coleslaw.html\")" \
-     --eval "(progn (terpri) (sb-ext:quit))"