Documentation approach

[cameronneylon]

Hi All

I thought I'd make a start on documentation, starting with the plugins. The idea is to create a template python plugin as well as template documentation. By using dexy I can incorporate testing into the documentation so that someone writing a new plugin just needs to drop in the appropriate URL, a couple of test parameters, and their code for parsing and this should both populate the documentation and effectively run the test. I've just created a dexy branch for this purpose which contains such a template but haven't started writing any actual docs as yet.

Any comments on the approach welcome but otherwise I'll try and make some progess over the weekend.

Cheers

Cameron

[pgroth]

Sounds good to me.

[cameronneylon]

Just looking at the plugins and thinking they probably need to be re-written to have a base plugin class but that's easy enough to do at some later point, I'll work up some template docs to start with and then see how far I get.

Cheers

Cameron

On 14 May 2011, at 10:40, pgroth wrote:

Sounds good to me.

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1161960

[pgroth]

Before rewriting anything I'd like to see the site up and working.

Cool on the docs though

Paul

Sent from my iPhone

On May 14, 2011, at 11:44, cameronneylonreply@reply.github.com wrote:

Just looking at the plugins and thinking they probably need to be re-written to have a base plugin class but that's easy enough to do at some later point, I'll work up some template docs to start with and then see how far I get.

Cheers

Cameron

On 14 May 2011, at 10:40, pgroth wrote:

Sounds good to me.

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1161960

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1161967

[cameronneylon]

Agreed. I won't touch anything at the moment in terms of running code, and certainly not on the master branch but will try to keep my eye on how the overall design would need to be worked up.

Cheers

Cameron

On 14 May 2011, at 10:57, pgroth wrote:

Before rewriting anything I'd like to see the site up and working.

Cool on the docs though

Paul

Sent from my iPhone

On May 14, 2011, at 11:44, cameronneylonreply@reply.github.com wrote:

Just looking at the plugins and thinking they probably need to be re-written to have a base plugin class but that's easy enough to do at some later point, I'll work up some template docs to start with and then see how far I get.

Cheers

Cameron

On 14 May 2011, at 10:40, pgroth wrote:

Sounds good to me.

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1161960

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1161967

Reply to this email directly or view it on GitHub: https://github.com/mhahnel/Total-Impact/issues/2#comment_1162001

[cameronneylon]

I've just pushed, with a great deal of help from @ananelson a version of the repo to the "dexy" branch on github that includes the beginning of a description of how to write the plugins with documentation that will also act as tests eventually. At the moment the docs just pull to code in but the aim is to incorporate running of the various routines and their results. After that works I'll merge this back into master, then start a new branch with the aim of improving the python plugins with a template class.

[hpiwowar]

moving away from this framework; will do api docs a different way.