[SciPy-Dev] How to preview changes to a doc file?

Paul van Mulbregt p.vanmulbregt at comcast.net
Wed Jun 7 16:12:55 EDT 2017


What is the recommended way to preview any documentation changes, such as after modifying restructured text (rst) files?

After adding some additional math to an rst file, I’d like to see the result of the change, but haven’t found a good way to do so.
[I’m using a Mac, with Python 3.6.]

* Attempts to build the scipy doc have not succeeded for me ("setup.py build_sphinx" generates lots of dvipng errors; perhaps building the doc requires Py2.7???)
* The Mac editor Atom has some rst preview packages, but I haven’t found one that can handle the \begin{eqnarray*} constructs in the scipy rst files.
* Stand-alone rst-viewers which then opened in a browser didn’t like the math either.
* One online viewer http://rst.ninjs.org <http://rst.ninjs.org/> did render the math in a fashion, after I had removed the ":nowrap:", and converted the backtick  :math:`XXX` to stand-alone math.  But it was a poor rendering when compared to the actual scipy html. 

How do you preview doc changes?

Thanks,
Paul


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20170607/83e6087c/attachment.html>


More information about the SciPy-Dev mailing list