New API documentation for Knop 9

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

New API documentation for Knop 9

stevepiercy
https://github.com/knop-project/knop/tree/master/knop9/docs/build

Thanks to Brad Lindsay for kick-starting this project, we now
have a new version of Knop 9 API documentation.  This
documentation supplements the Knop 8 version of help.lasso, but
outputs it to reStructuredText (reST) format.  Then with Sphinx,
we are able to render the documentation to any format, including
HTML, PDF, and ePub, all of which formats are available at the
above URL.  These formats are easier to search than the old
help.lasso, and even the HTML version has its own search feature
if you set up a virtual host for it.

Next steps are to be determined, and will reference this open issue:
https://github.com/knop-project/knop/issues/25

--steve

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- --
Steve Piercy               Web Site Builder              
Soquel, CA
<[hidden email]>                  <http://www.StevePiercy.com/>


--
#############################################################
This message is sent to you because you are subscribed to
the mailing list <[hidden email]>.
To unsubscribe, E-mail to: <[hidden email]>
Send administrative queries to  <[hidden email]>
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/
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: New API documentation for Knop 9

list
That's just spectacular work, Steve and Brad!

Urges me to actually use the documentation option available when writing Knops Lasso 9 types, threads and methods.
...There are a number of types/methods that really can use a bit more love and care from a documentation point of view...

It also highlights the need of a place where this can be published in a polished form. With some attractive css sweetening and additional material. Like for example a Lasso 9 savvy demo.

HDB
Jolle

7 dec 2012 kl. 22:21 skrev Steve Piercy - Web Site Builder <[hidden email]>:

> https://github.com/knop-project/knop/tree/master/knop9/docs/build
>
> Thanks to Brad Lindsay for kick-starting this project, we now have a new version of Knop 9 API documentation.  This documentation supplements the Knop 8 version of help.lasso, but outputs it to reStructuredText (reST) format.  Then with Sphinx, we are able to render the documentation to any format, including HTML, PDF, and ePub, all of which formats are available at the above URL.  These formats are easier to search than the old help.lasso, and even the HTML version has its own search feature if you set up a virtual host for it.
>
> Next steps are to be determined, and will reference this open issue:
> https://github.com/knop-project/knop/issues/25
>
> --steve
>
> -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
> Steve Piercy               Web Site Builder               Soquel, CA
> <[hidden email]>                  <http://www.StevePiercy.com/>
>
>
> --
> #############################################################
> This message is sent to you because you are subscribed to
> the mailing list <[hidden email]>.
> To unsubscribe, E-mail to: <[hidden email]>
> Send administrative queries to  <[hidden email]>
> 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/
>
>



--
#############################################################
This message is sent to you because you are subscribed to
the mailing list <[hidden email]>.
To unsubscribe, E-mail to: <[hidden email]>
Send administrative queries to  <[hidden email]>
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/
Loading...