Discussion:
Docs
Sebastian Oliva
2013-12-06 18:54:35 UTC
Permalink
Hi, I tried building the docs, and broke. And the docs on
http://shoebot.readthedocs.org/en/latest/ are really outdated. How can
I build it?

Cheers!
Stuart Axon
2013-12-13 01:49:17 UTC
Permalink
Hi,
   I'm not near my computer.   From memory: The docs are generated by sphinx, which uses restructured text format.
 
 
To generate the doc:   You need sphinx, shoebot + Make installed.   Go to the 'doc' directory, 'make html' will generate the html docs.
 
Updating the docs would be super useful, a lot of them are out of date, any updates there would be really good.
 
[These are the same docs that end up on ReadTheDocs, I think Ricardo got them on there]

S++


http://sphinx-doc.org/tutorial.html



On Friday, December 6, 2013 6:54 PM, Sebastian Oliva <tian2992-***@public.gmane.org> wrote:

Hi, I tried building the docs, and broke. And the docs on
http://shoebot.readthedocs.org/en/latest/are really outdated. How can
I build it?
Cheers!
_______________________________________________
Shoebot-devel mailing list
http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
Ricardo Lafuente
2014-01-02 17:43:14 UTC
Permalink
Post by Stuart Axon
[These are the same docs that end up on ReadTheDocs, I think Ricardo got them on there]
This is correct, though the auto-generation of snippet output only works
when building the docs locally, IIRC.
Post by Stuart Axon
Updating the docs would be super useful, a lot of them are out of
date, any updates there would be really good.
+1. If anyone wants to hack on this in the near future, I'm more than
happy to help the effort.

:r
Post by Stuart Axon
On Friday, December 6, 2013 6:54 PM, Sebastian Oliva
Hi, I tried building the docs, and broke. And the docs on
http://shoebot.readthedocs.org/en/latest/are really outdated. How can
I build it?
Cheers!
_______________________________________________
Shoebot-devel mailing list
http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
_______________________________________________
Shoebot-devel mailing list
http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
Stuart Axon
2014-01-09 17:30:34 UTC
Permalink
I'll be up hacking on docs, it just might not be the near future ... still, I think bug #1 is the blocking bug I want to sort before I come back to docs :)
 
S++
Post by Ricardo Lafuente
Post by Stuart Axon
[These are the same docs that end up on ReadTheDocs, I think Ricardo got them on there]
This is correct, though the auto-generation of snippet output only works
when building the docs locally, IIRC.
Post by Stuart Axon
Updating the docs would be super useful, a lot of them are out of
date, any updates there would be really good.
+1. If anyone wants to hack on this in the near future, I'm more than
happy to help the effort.
:r
Post by Stuart Axon
On Friday, December 6, 2013 6:54 PM, Sebastian Oliva
    Hi, I tried building the docs, and broke. And the docs on
    http://shoebot.readthedocs.org/en/latest/are really outdated. How can
    I build it?
    Cheers!
    _______________________________________________
    Shoebot-devel mailing list
    http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
_______________________________________________
Shoebot-devel mailing list
http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
_______________________________________________
Shoebot-devel mailing list
http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net
Loading...