[knop-project] Updated API docs

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
Report Content as Inappropriate

[knop-project] Updated API docs

Hi Everyone,

I've pushed up a new rendered set of API docs.  I combined the
existing gen_source_docs.inc by Brad Lindsay and Eric Knibbe's
sphinxifier.lasso to hack something together that seems to show
all the Knop types and methods.

Unfortunately neither has the capacity to render docstrings or
doccomments very well if at all, so descriptions of the type,
method, and its parameters are not present.  This makes me sad,
as it made the help from Knop for Lasso 8 very useful.  I looked
into how LassoGuide is generated, but it appears that
sphinxifier was used initially, then the descriptions were
manually populated.

Anywho, you can check out the branch 'docs-update' and load this
up in a web browser to check it out.

Eventually, I will merge the markdown docs and reST docs, with a
narrative section and an API section.


-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Steve Piercy              Website Builder              Soquel, CA
<[hidden email]>               <http://www.stevepiercy.com/>

You received this message because you are subscribed to the Google Groups "knop-project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/knop-project.
To view this discussion on the web visit https://groups.google.com/d/msgid/knop-project/r473Ps-10122i-0D5D2E238BDF4BC79079743518D1E630%40Steves-iMac.local.
For more options, visit https://groups.google.com/d/optout.