Steve Piercy - Web Site Builder Documentation of Knop for Lasso 9 API
Jul 09, 2012; 02:32
Steve Piercy - Web Site Builder
Documentation of Knop for Lasso 9 API
=46ellow Knop-ers have an itch to scratch. In Lasso 8, we have this pretty nifty semi-automatic documentation of the Knop API and its types and methods.
http://montania.se/projects/knop/help.lasso
It's not fully automatic. We meticulously added all that information for each method as the value for the -description parameter. help.lasso parses the string, then formats it to look pretty. The output is nice, but the labor involved and potential for mistakes is not so much. Also it is not in a single searchable file (like a PDF) and it lacks a search feature (excluding in-browser searching, of course).
Thus we've been looking at better ways of documenting the Knop API for Lasso 9. Our goals are:
* Write source code once and parse the source for API documentation. * Read a method's signature and return its parameters, traits, and other elements into a structure that can be easily parsed. * Avoid use of -description, if possible. * Use a simple markup language (like .rst) that can be parsed easily and output to HTML, RTF, plain text, or PDF. * Generate a searchable index.
Essentially we're looking to create a Lasso domain for Sphinx. http://sphinx.pocoo.org/domains.html
We're only at the concept stage. We do not know of any specific Lasso types or methods that could be used to facilitate production of a domain for Sphinx. However we know that something is possible because the error stack in Lasso 9 returns a lot of great information, like "possible candidates were". How do we get those tasty morsels of Lasso 9 introspective goodness without throwing an error?
We are open to collaborate with any developer on this effort. https://github.com/knop-project/knop/issues/25
--steve
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Steve Piercy Web Site Builder Soquel, CA <web@StevePiercy.com> <http://www.StevePiercy.com/>
-- ############################################################# This message is sent to you because you are subscribed to the mailing list <knop@lists.montania.se>. To unsubscribe, E-mail to: <knop-off@lists.montania.se> Send administrative queries to <knop-request@lists.montania.se> List archive http://lasso.2283332.n4.nabble.com/Knop-Framework-Discussion-f3157831.html Project homepage http://montania.se/projects/knop/ Google Code has the latest downloads at http://code.google.com/p/knop/
Search
Lasso Programming
This site manages and broadcasts several email lists pertaining to Lasso Programming and technologies related and used by Lasso developers. Sign up today!