README.md (1452 bytes)
1 Warning: This is an attempt to take some code from StumpWM and make it a 2 separate library. It may not work very well yet, and breaking changes may occur. 3 4 # Sigil 5 6 Generate documentation for sigil lines in the source, according to some input 7 documentation standard. This is intended to be the first pass in processing some 8 documentation. 9 10 This library is modified from that used to generate the docs for 11 [StumpWM](https://stumpwm.github.io/). 12 13 ## Usage 14 Each "sigil" is a three character string must be at the beginning of the line, 15 and followed by a Common Lisp symbol. Some projects may need to define their own 16 sigils using `defdoc`. 17 18 Default included sigils: 19 ```tex 20 @@@ function 21 %%% macro 22 ### variable 23 ``` 24 25 ### Texinfo 26 Currently the only supported output format is texinfo. 27 28 input: 29 ``` tex 30 @c This is a texinfo comment. It will not be exported. 31 @c defun is a macro defined in the standard. 32 %%% defun 33 ``` 34 Which expands to: 35 ``` 36 @c defun is a macro defined in the standard. 37 @defmac {defun} name lambda-list &body body 38 Define a function at top level. 39 @end defmac 40 ``` 41 ## Install 42 Requires SBCL, because `sb-introspect` is used. Support for other 43 implementations is welcome. 44 45 ## Hacking 46 Write new sigils with the `defdoc` macro. 47 48 ### TODO 49 - Be more general in supporting more output types than tex. 50 - Do not require sb-introspect, use other methods or leave out certain data as 51 needed. 52 53 ## License 54 55 GNU GPL v3 56 57 ### _Spenser Truex <web@spensertruex.com>_