This site's goal is to help you to choose a Common Lisp documentation builder suited your needs.
There are separate repositories with example projects. Each project uses a different documentation builder. But all projects are similar in their structure. All of them define a few packages, functions and classes.
Here is a list of documentation builders along with their main strengths:
-
Really simple.
-
Readable color scheme.
-
No way to write free documentation chapters.
-
You can write an extensions to support markups other than Markdown.
-
Links to HyperSpec from code snippets.
-
Supports different themes.
-
Custom markup format, but you can extend it with other markups.
-
Links to HyperSpec using special tag.
-
Uses reStructured text format.
-
New types of reST blocks can be written in Common Lisp.
-
Provides cross-reference helpers.
-
Unique docstring parser which is works with custom forms.
-
Works with all markups supported by Pandoc.
-
Automatic discovery of documentation files.
- Custom markup format mk2.
-
Uses Markdown.
-
Provides convenient cross-reference helpers.
-
Has nice default scheme.
-
Is able to generate not only HTML, but also a markdown README file.
-
Nudge you too keep documentation as close to to the code as possible. You can define doc sections in the lisp files.
-
Uses reStructured text format and external Sphinx builder.
-
Can use all extensions provided by Sphinx, like builtin search facitility.
-
Suitable for large multipart documents.
-
Provides cross-reference helpers.
-
You can reference symbol just by uppercasing.
-
Complex to setup.
-
Rendered documentation is nice.
-
Can be problems with package inferred systems.
-
No way to write free documentation chapters.
-
Links to the doc sources on the github.