knop-project/knop — pull request #66 by bfad (2012-12-07 01:46:54+00:00)
Title: Autodoc

This code begins the process of using Sphinx to automatically document the Lasso 9 version of Knop. I have created a command-line Lasso script called "gen_source_docs.inc" that creates reStructuredText files from the types and methods defined in the knoplibs folder. It puts these files in the proper place for Sphinx and updates the Sphinx index.rst document. From there you can use Sphinx's make file to create HTML documentation. Currently it is using the Python domain in Sphinx as a Lasso domain has yet to be developed. This may be less than optimal, but it at least gives us a starting point to generate the documentation.

I have also gone through all the docComments for the code in knoplibs folder and cleaned them up to be syntactically valid reStructuredText markup. This means you shouldn't see any errors listed when Sphinx builds the documentation. Also, I only through in a couple of examples of cross-referencing in the documentation for knop_cachefetch and knop_cachestore, so there is more work to be done on that front as well.