Shoebot documentation

[Stuart Axon]

To lower the barrier to entry we could do better at documentation.  I've only just looked at sphinx for the 1st time so only just realised we can generate some using the docs dir.

I've put a note in the README about generating sphinx docs.


If possible we need a way to generate a list of shoebot commands

Processing reference:
http://processing.org/reference/

 
Nodebox 1 reference:
http://nodebox.net/code/index.php/Reference


I'm not sure where to start to do this, any ideas are welcome ?

I guess if we move to github it'd be good if we could host our html docs somewhere (shoebot.net or readthedocs for instance).

[Dave Crossland]

Post by Stuart Axon
I guess if we move to github it'd be good if we could host our html docs
somewhere

GitHub does html doc hosting, with 'Jeykll' to process MarkDown into
HTML with basic templating:

http://pages.github.com/

https://help.github.com/categories/20/articles

[Ricardo Lafuente]

Post by Dave Crossland

Post by Stuart Axon
I guess if we move to github it'd be good if we could host our html docs
somewhere

GitHub does html doc hosting, with 'Jeykll' to process MarkDown into
http://pages.github.com/
https://help.github.com/categories/20/articles

We can use this for the website itself and redirect the shoebot domains
there, making everything simpler.

Wrt documentation, Sphinx is pretty great and I would stick to it if
possible. It has an 'autodoc' function for creating API docs, though I
never got serious with it. We can meet sometime soon on IRC to hack
together on it.

Finally, I found this light hack to get Sphinx pages hosted on Github,
looks like what we need:
http://datadesk.latimes.com/posts/2012/01/sphinx-on-github/