Skip to content

Loading…

Make nicer documentation #481

Closed
dnschnur opened this Issue · 4 comments

1 participant

@dnschnur
Flot member

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

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

Cheers

Original issue: http://code.google.com/p/flot/issues/detail?id=402

@dnschnur
Flot member

From olau%iol...@gtempaccount.com on March 11, 2011 12:28:28
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.

@dnschnur
Flot member

From dro...@gmail.com on March 11, 2011 13:33:18
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.

@dnschnur
Flot member

From olau%iol...@gtempaccount.com on March 11, 2011 16:25:14
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.

This was referenced
@dnschnur dnschnur was assigned
@dnschnur
Flot member

Resolved for the 0.8.0 release by pull request #940 and the earlier switch to Markdown for API docs formatting. There are of course many more docs and examples improvements that we plan to make in the future.

@dnschnur dnschnur closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.