|
Last change
on this file was
14765,
checked in by Mark Evenson, 10 years ago
|
|
doc: fixes for grovelling docstrings
Document how to grovel docstrings in <file:doc/manual/README.md>.
Escape #\_ characters.
Don't emit documentation for a symbol without definitions.
|
|
File size:
909 bytes
|
| Line | |
|---|
| 1 | ABCL User Manual |
|---|
| 2 | ================ |
|---|
| 3 | |
|---|
| 4 | With a suitable TexLive installed, to build simply run `make`. If you |
|---|
| 5 | cannot run make, the following sequence of commands also gets you a pdf |
|---|
| 6 | of the manual: |
|---|
| 7 | |
|---|
| 8 | cmd$ pdflatex abcl.tex && bibtex abcl && makeindex abcl && pdflatex abcl.tex && pdflatex abcl.tex |
|---|
| 9 | |
|---|
| 10 | |
|---|
| 11 | ## Generating docstrings |
|---|
| 12 | |
|---|
| 13 | 1. Ensure that the toplevel 'abcl.asd' is loadable by ASDF. |
|---|
| 14 | |
|---|
| 15 | If the ABCL source resides in "~/work/abcl/", this can be |
|---|
| 16 | accomplished by creating the file |
|---|
| 17 | <file:~/.config/common-lisp/source-registry.conf.d/abcl.conf> with |
|---|
| 18 | the contents: |
|---|
| 19 | |
|---|
| 20 | (:tree (:home "work/abcl/")) |
|---|
| 21 | |
|---|
| 22 | 2. Execute the following code from the ABCL REPL: |
|---|
| 23 | |
|---|
| 24 | (require :abcl-contrib) |
|---|
| 25 | (require :jss) |
|---|
| 26 | (asdf:load-system :abcl/documentation) |
|---|
| 27 | (loop :for package |
|---|
| 28 | :in '(:java :ext :sys :jss :mop :threads) |
|---|
| 29 | :doing (abcl/documentation:grovel-docstrings-as-tex :package package)) |
|---|
| 30 | |
|---|
Note: See
TracBrowser
for help on using the repository browser.
