Recently Written · git

sigil

A documentation preprocessor for Common Lisp docs

git clone https://github.com/equwal/sigil

Log | Files | Refs


commit 3a30a1e0ce8e5435aaaf629b8a123edccc5e7290
Spenser Truex <web@spensertruex.com>
2020-03-26 15:33:13 -0700

Rename to sigil -- should more than texinfo later

 README.md                   | 6 +++++-
 manual.lisp                 | 9 +++++----
 package.lisp                | 2 +-
 texi-macro.asd => sigil.asd | 2 +-
 4 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 9ae612f..4794d72 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# texi-macro
+# Sigil
 
 Generate source documentation inside of texinfo files with short macros.
 
@@ -22,6 +22,10 @@ implementations is welcome.
 ## Hacking
 Write new forms with the `defdoc` macro.
 
+### TODO
+
+- Be more general in supporting more output types than tex.
+
 ## License
 
 GNU GPL 2.0
diff --git a/manual.lisp b/manual.lisp
index b183aef..e2b241c 100644
--- a/manual.lisp
+++ b/manual.lisp
@@ -15,12 +15,13 @@
 ;;;; <http://www.gnu.org/licenses/>.
 
 ;;;; Commentary:
-;;;;
-;;;; Generate the texinfo manual from docstrings in the source.
-;;;;
+;;;
+;;; Generate documentation for sigil lines in the source, according to some
+;;; input documentation standard.
+;;;
 ;;;; Code:
 
-(in-package #:texi-macro)
+(in-package #:sigil)
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defvar *doc-fns* nil "The functions used to generate documents.")
diff --git a/package.lisp b/package.lisp
index b3ece35..9edb12b 100644
--- a/package.lisp
+++ b/package.lisp
@@ -1,3 +1,3 @@
-(defpackage :texi-macro
+(defpackage :sigil
   (:use :cl)
   (:import-from :sb-introspect :function-lambda-list))
diff --git a/texi-macro.asd b/sigil.asd
similarity index 93%
rename from texi-macro.asd
rename to sigil.asd
index b876f26..59cb20a 100644
--- a/texi-macro.asd
+++ b/sigil.asd
@@ -1,4 +1,4 @@
-;;;; texi-macro.asd
+;;;; sigil.asd
 
 (asdf:defsystem #:texi-macro
   :description "Texinfo sigils for Common Lisp documentation."