Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTML manual #16

Open
rainwoodman opened this issue Sep 4, 2015 · 4 comments
Open

HTML manual #16

rainwoodman opened this issue Sep 4, 2015 · 4 comments

Comments

@rainwoodman
Copy link
Contributor

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 .

@mpip
Copy link
Owner

mpip commented Sep 5, 2015

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.

@rainwoodman
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@mpip
Copy link
Owner

mpip commented Sep 9, 2015

Ok. Great. Thanks a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants