<div dir="ltr"><div>Is it worth considering something that works with the existing sphinx documentation?<br><a href="https://jsdoc-toolkit-rst-template.readthedocs.org/en/latest/index.html">https://jsdoc-toolkit-rst-template.readthedocs.org/en/latest/index.html</a><br><br></div><div>This is used, for example, by safari books online:<br><a href="https://pypi.python.org/pypi/sbo-sphinx/2.0.2">https://pypi.python.org/pypi/sbo-sphinx/2.0.2</a><br><br></div><div>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!<br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Oct 23, 2014 at 4:04 PM, Jonathan Frederic <span dir="ltr"><<a href="mailto:jon.freder@gmail.com" target="_blank">jon.freder@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">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): <a href="http://usejsdoc.org/about-getting-started.html" target="_blank">http://usejsdoc.org/about-getting-started.html</a> .  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: <a href="http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/" target="_blank">http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/</a><br><div><br></div><div>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.</div><div><br></div><div>Cheers,</div><div>Jon</div></div>
<br>_______________________________________________<br>
IPython-dev mailing list<br>
<a href="mailto:IPython-dev@scipy.org">IPython-dev@scipy.org</a><br>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-dev" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-dev</a><br>
<br></blockquote></div><br></div>