[IPython-dev] Javascript comments

Nicholas Bollweg nick.bollweg at gmail.com
Thu Oct 23 21:31:51 EDT 2014

Is it worth considering something that works with the existing sphinx

This is used, for example, by safari books online:

And while "jupyter != ipython" might be valid here, the fact remains that
sphinx makes very nice output documents... nice enough to be used by the
official julia documentation, for example!

On Thu, Oct 23, 2014 at 4:04 PM, Jonathan Frederic <jon.freder at gmail.com>

> As a follow up of today's meeting, it looks like, if we don't mind the
> comment appearing before the function, JSDoc allows for our own doc string
> format (see simplest case): http://usejsdoc.org/about-getting-started.html
> .  JSDoc claims to be "highly extensible" and has a markdown plugin
> distributed with it.  Here's a good article comparing the 4 most popular JS
> comment -> API doc tools:
> http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/
> My preference is for JSDoc, but I'd like to hear what others think.  Also
> the option to NOT use a comment -> doc parser still exists.  Provided we
> can commit to keeping a separate API docs by hand.
> Cheers,
> Jon
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20141023/6804c25a/attachment.html>

More information about the IPython-dev mailing list