Generating Documentation

When all is said and done (i.e. your demos pass ;p), good looking documentation can be generated directly from the QED markups. Since these files use common markup formats, RDoc or Markdown, it’s easy enough to generate the documentation with your favorite tool or by writing a quick script. Nonetheless Q.E.D. provides a built-in tool called qedoc to help you out. Here is an example of using the command:

    $ qedoc --output doc/qedoc test/demos/*.rdoc

And here is an example of its output.