Make nicer documentation

faheem801 / flot

Automatically exported from code.google.com/p/flot

MIT License

0 stars 0 forks source link

Make nicer documentation #402

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago

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:
http://github.com/drozzy/Flot-Documentation

Here is the output it produces:
http://drozzy.com

Cheers

Original issue reported on code.google.com by dro...@gmail.com on 24 Aug 2010 at 8:21

GoogleCodeExporter commented 9 years ago

Hi! I'm sorry for not getting back to you earlier. I think there has been some 
work by others recently, I haven't had time to review it but in case you're 
still interested in working on it.

I think another format would be great and would be happy to support it.

Original comment by olau%iol...@gtempaccount.com on 11 Mar 2011 at 12:28

Added labels: Type-Enhancement
Removed labels: Type-Defect

GoogleCodeExporter commented 9 years ago

Can you provide me with links of the other peoples contributions? Are they in 
source or in issue tracker?

Have you looked at the readme file I created in rst here:
https://github.com/drozzy/Flot-Documentation/blob/master/source/readme.rst

This is how it looks.

The whole project in git is a Sphinx project:
http://sphinx.pocoo.org/

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.

Original comment by dro...@gmail.com on 11 Mar 2011 at 1:33

GoogleCodeExporter commented 9 years ago

Ah, I think I understand what you've done now.

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.

Original comment by olau%iol...@gtempaccount.com on 11 Mar 2011 at 4:25

GoogleCodeExporter commented 9 years ago

Issue 493 has been merged into this issue.

Original comment by olau%iol...@gtempaccount.com on 4 Apr 2011 at 10:20

GoogleCodeExporter commented 9 years ago

Issue 551 has been merged into this issue.

Original comment by olau%iol...@gtempaccount.com on 23 Jun 2011 at 7:20

GoogleCodeExporter commented 9 years ago

Original comment by dnsch...@gmail.com on 7 May 2012 at 5:54

Changed state: Accepted