pfft icon indicating copy to clipboard operation
pfft copied to clipboard

Published 20 hours ago • verified publisher icon mpip

HTML manual

Open rainwoodman opened this issue 10 years ago • 4 comments

The current manual is written strictly in Latex, and it may be hard to compile it to HTML pages.

HTML documentation is easier to access than PDF documentation, because 1) it doesn't need a PDF reader and 2) is easier to search; and 3) is paginated by sections rather than by pages.

For HTML generation, I would recommend looking into restructured text and sphinx. It will produce HTML and pdf documents.

If this is desired I can start a PR start porting tex to .rst .

rainwoodman avatar Sep 04 '15 22:09 rainwoodman

Looks interesting. In former times I tried to convert latex to html with no sufficient success. If sphinx has sufficient support for LaTeX (equations and syntax highlighting via listings) we can give it a try. You are very welcome to set up a starting point.

mpip avatar Sep 05 '15 02:09 mpip

Here is an example document

(html) http://matplotlib.org/sampledoc/ (pdf) http://matplotlib.org/sampledoc/sampledoc.pdf

Looks like it can handle the elements in the current manual(math and highlighting), but the 'default' styles may look a bit different.

rainwoodman avatar Sep 05 '15 20:09 rainwoodman

I will get this started around the end of this week.

rainwoodman avatar Sep 09 '15 03:09 rainwoodman

Ok. Great. Thanks a lot.

mpip avatar Sep 09 '15 04:09 mpip