Ask Your Question

Revision history [back]

How to read rst files?

Hi.

I just downloaded alpha 3.0. I've been using OpenCV for many years. Most recently version 2.3. You now have all documentation files in .rst format. I am most interested in the tutorials. But they are not included in the online documentation(except for python). So I am left with the .rst files. How do I read them? You have no documentation on available readers. Nor does a quick Google search help -- it only yields the unhelpful hint that it is a Python invention.

I would suggest a readme.txt file in the doc subdirectory for people such as me -- I use C++/matlab. Not Python.

After a few hours of looking I've found that Restructured Text was written by Georg Brandl, goes by the appropriately name of Sphinx (as in "inscrutable" or hard to find), and is used primarily for Python documentation. But finding a way to actually read these files is problematic, especially for those of us who don't use Python frequently -- and yes, I've written python scripts (100's of lines) earlier this year, but am not embedded in all the peripheral stuff that hard core python users may be familiar with) such as this.

So, I guess I need to first install Python. then modify my paths. According to http://sphinx-doc.org/install.html I also need to run the "easy_install" from the setup tools, and a few more steps. I suspect all this is for creating documents (but they don't say so). But all I want to do is read the rst files.

Help would be appreciated. Preferably, provide the HTML/PDF files in you doc directories, since these are industry standards.

Mark DeNies