[Sugar-devel] Javascript API documentation

[Daniel Narvaez]

I added docker to sugar-build and buildbot. The html is generated in the
out/docs directory and whenever I can get the builds to fully work again it
will be uploaded to the usual place.

We probably should replace the sidebar with a friendly index at some point,
for now I think that's good enough.

A flag needs to be added in sugar-build/config/modules to each module that
has docs, right now we only build them for sugar-docs.


On 15 May 2013 18:25, Manuel Quiñones <manuq at laptop.org> wrote:

> 2013/5/15 Manuel Quiñones <manuq at laptop.org>:
> > 2013/5/15 Daniel Narvaez <dwnarvaez at gmail.com>:
> >> By the way, tempted to use this for sugar-docs too. It's not code but
> even
> >> their site is using it for md files.
> >>
> >> We could add a docs command to sugar-build and has_docs/docs_dir
> properties
> >> to the modules configuration. The run docker on each has_docs module and
> >> output in docs/docs_dir. Finally have buildbot upload docs/ as
> >> developer.sugarlabs.org.
> >
> > Excellent, let's go with docker then.  I agree using it for sugar-docs
> too.
> >
> > --
> > .. manuq ..
>
> Docker also supports jsdoc syntax, so we should be safe:
>
> https://github.com/jbt/docker/blob/master/src/docker.js#L153
>
> translates to:
>
>
> http://jbt.github.io/docker/src/docker.js.html#docker.prototype.checkforpygments
>
> --
> .. manuq ..
>



-- 
Daniel Narvaez
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20130518/2bafb1e0/attachment.html>