Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Make nicer documentation #481
Original author: dro...@gmail.com (August 24, 2010 20:21:01)
The documentation is one long plain-text file. Hard to read, navigate, and impossible to bookmark.
My suggestion would be to use some form of HTML documentation.
I threw together a rough outline of a sphinx project:
Here is the output it produces:
Original issue: http://code.google.com/p/flot/issues/detail?id=402
From olau%iol...@gtempaccount.com on March 11, 2011 12:28:28
I think another format would be great and would be happy to support it.
From dro...@gmail.com on March 11, 2011 13:33:18
Have you looked at the readme file I created in rst here:
This is how it looks.
The whole project in git is a Sphinx project:
a python-based doc compiler.
If you want to use it just clone it from the repo. I don't think there is much to work on - except on the initial setup and then updating it from time to time.
From olau%iol...@gtempaccount.com on March 11, 2011 16:25:14
Regarding other initiatives, there's nothing in this issue tracker or code right now. There might be some in a fork that currently exist on github. I am not currently sure how that's going to be resolved, but I'll keep you in mind - I'm trying to get 0.7 out of the door Real Soon so this will have to wait a bit.