Updated API docs

1 view
Skip to first unread message

Steve Piercy - Website Builder

unread,
Feb 2, 2017, 6:00:29 AM2/2/17
to Knop List
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.
https://bitbucket.org/EricFromCanada/ericfromcanada.bitbucket.org/raw/default/lasso/sphinxifier.lasso

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.
https://github.com/LassoSoft/LassoGuide

Anywho, you can check out the branch 'docs-update' and load this
up in a web browser to check it out.
https://github.com/knop-project/knop/tree/docs-update/docs/build/html

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

--steve

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Steve Piercy Website Builder Soquel, CA
<w...@stevepiercy.com> <http://www.stevepiercy.com/>

Steve Piercy - Website Builder

unread,
Feb 3, 2017, 1:48:07 AM2/3/17
to Knop List
And now I got it configured such that the docs are published on
Read the Docs upon each push to the GitHub repo.
https://knop.readthedocs.io/en/docs-update/

Currently only the branch `docs-update` gets published, but that
will change when I merge it to `master`.

One of the nice things about RTD is that you don't have to build
the docs yourself and it can build both HTML, PDF, and epub
versions automatically.

--steve


On 2/2/17 at 3:00 AM, w...@stevepiercy.com (Steve Piercy -
Website Builder) pronounced:
Reply all
Reply to author
Forward
0 new messages