<div>i don&#39;t know if you&#39;ve seen this before, but might be useful:</div><div><br></div><div><a href="http://rst.ninjs.org/">http://rst.ninjs.org/</a></div><div><br></div>cheers,<br><br>satra<br><br>
<br><br><div class="gmail_quote">On Sat, Sep 17, 2011 at 1:16 AM, Brian Granger <span dir="ltr">&lt;<a href="mailto:ellisonbg@gmail.com">ellisonbg@gmail.com</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">

I can outline our plans for supporting reST in the notebook.<br>
<br>
* The problem with reST is that it can only render entire documents<br>
and not parts of documents.  Because of this, it can&#39;t be used to<br>
render a single reST text cell in any way that behaves as people<br>
expect.  Examples are section headings and references, which are<br>
contextual and require the entire document to make sense of.  A more<br>
formal way of putting this is:<br>
<br>
rest_render(cell[0]) + rest_render(cell[1]) != rest_render(cell[0] + cell[1])<br>
<br>
Markdown does not suffer from these design limitations and this is why<br>
it is our default for rich text cells in the notebook.<br>
<br>
* Obviously reST is very important to the python community and we want<br>
to support reST.  Here is how we plan on doing this.  The problem is<br>
in the rendering of individual cells.  We will implement reST text<br>
cells that simply don&#39;t render to HTML in the notebook as the Markdown<br>
cells do.  They will remain reST source and be stored in that form in<br>
the notebook format.<br>
<br>
* Notebooks with reST text cells can be exported to reST easily and<br>
then rendered to HTML/LaTeX as desired.<br>
<br>
* reST document will be able to be imported into the notebook once<br>
this is implemented as well.<br>
<br>
The most important point in all of this is that the problem is reST<br>
itself, not the IPython notebook.  I actually spent a couple of days<br>
trying to hack reST support into the notebook using various tricks.<br>
At the end of it all my conclusion was a somewhat depressing &quot;wow,<br>
reST is simply not designed for this usage case, but Markdown is a<br>
perfect fit&quot;<br>
<br>
Cheers,<br>
<br>
Brian<br>
<div><div></div><div class="h5"><br>
On Fri, Sep 16, 2011 at 9:17 PM, MinRK &lt;<a href="mailto:benjaminrk@gmail.com">benjaminrk@gmail.com</a>&gt; wrote:<br>
&gt;<br>
&gt;<br>
&gt; On Fri, Sep 16, 2011 at 20:44, Gael Varoquaux<br>
&gt; &lt;<a href="mailto:gael.varoquaux@normalesup.org">gael.varoquaux@normalesup.org</a>&gt; wrote:<br>
&gt;&gt;<br>
&gt;&gt; On Fri, Sep 16, 2011 at 08:41:23PM -0700, MinRK wrote:<br>
&gt;&gt; &gt;      I noticed that github allows you to choose between several<br>
&gt;&gt; &gt; different<br>
&gt;&gt; &gt;      languages for wiki input so I thought you might have something like<br>
&gt;&gt; &gt;      that in mind.  I&#39;ve been using reST for docstrings, sphinx docs,<br>
&gt;&gt; &gt; and<br>
&gt;&gt; &gt;      github so I selfishly would prefer not to have to learn another<br>
&gt;&gt; &gt;      simplified markup language.<br>
&gt;&gt;<br>
&gt;&gt; &gt;    That makes sense, and I expect we will get this request often.  The<br>
&gt;&gt; &gt;    problem is reST is really a horrible language<br>
&gt;&gt; &gt;    for in-browser cell markup (as opposed to full document markup, for<br>
&gt;&gt; &gt; which<br>
&gt;&gt; &gt;    it is designed),<br>
&gt;&gt;<br>
&gt;&gt; Actually, reST was originally designed to write docstrings.<br>
&gt;<br>
&gt; Ah, I didn&#39;t know that, given that its design is so much better suited to<br>
&gt; large documents than small isolated text.<br>
&gt;<br>
&gt;&gt;<br>
&gt;&gt; It seems to me wrong to go with any other markup language, given that the<br>
&gt;&gt; standard in the Python world in reST. It is hard enough to agree on<br>
&gt;&gt; standards, let us rejoice that there is one.<br>
&gt;<br>
&gt; We thought about this quite a bit, and concluded that markdown was just a<br>
&gt; better<br>
&gt; fit, despite the Python-ness of reST.  reST is just a very bad tool for<br>
&gt; interactive, light text markup,<br>
&gt; but if you can point me to a good javascript reST renderer, we can<br>
&gt; reconsider.<br>
&gt;<br>
&gt;&gt;<br>
&gt;&gt; Gael<br>
&gt;<br>
&gt;<br>
</div></div><div class="im">&gt; _______________________________________________<br>
&gt; IPython-dev mailing list<br>
&gt; <a href="mailto:IPython-dev@scipy.org">IPython-dev@scipy.org</a><br>
&gt; <a href="http://mail.scipy.org/mailman/listinfo/ipython-dev" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-dev</a><br>
&gt;<br>
&gt;<br>
<br>
<br>
<br>
</div><font color="#888888">--<br>
Brian E. Granger<br>
Cal Poly State University, San Luis Obispo<br>
<a href="mailto:bgranger@calpoly.edu">bgranger@calpoly.edu</a> and <a href="mailto:ellisonbg@gmail.com">ellisonbg@gmail.com</a><br>
</font><div><div></div><div class="h5">_______________________________________________<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>
</div></div></blockquote></div><br>