X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=155393b8a32912604f4d80e0b881cc4c56af6ae4;hb=44f29e932dcbe83c1bfaebb8735579392e27a5df;hp=3c4d1fe8d1f6de254833c930da1fd66bbef7f13b;hpb=a38e9336f3e1696946067bd5c63c838f63d2ca6b;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index 3c4d1fe..155393b 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -59,9 +59,15 @@ print """ Dygraphs Options Reference + @@ -69,18 +75,53 @@ print """ """ -print 'Options categories:\n' -print '\n\n\n' def name(f): """Takes 'tests/demo.html' -> 'demo'""" return f.replace('tests/', '').replace('.html', '') +print """ +
+

Options Reference

+

Dygraphs tries to do a good job of displaying your data without any further configuration. But inevitably, you're going to want to tinker. Dygraphs provides a rich set of options for configuring its display and behavior.

+ +

Usage

+

You specify options in the third parameter to the dygraphs constructor: +

g = new Dygraph(div,
+                data,
+                {
+                  option1: value1,
+                  option2: value2,
+                  ...
+                });
+
+ +After you've created a Dygraph, you can change an option by calling the updateOptions method: +
g.updateOptions({
+                  new_option1: value1,
+                  new_option2: value2
+                });
+
+ +

And, without further ado, here's the complete list of options:

+""" for label in sorted(labels): - print '

%s

\n' % (label, label) + print '

%s

\n' % (label, label) for opt_name in sorted(docs.keys()): opt = docs[opt_name] @@ -92,8 +133,12 @@ for label in sorted(labels): examples_html = ' '.join( '
%s' % (f, name(f)) for f in tests) + if not opt['type']: opt['type'] = '(missing)' + if not opt['default']: opt['default'] = '(missing)' + if not opt['description']: opt['description'] = '(missing)' + print """ -

%(name)s
+

%(name)s
%(desc)s
Type: %(type)s
Default: %(default)s

@@ -106,5 +151,11 @@ for label in sorted(labels): 'examples_html': examples_html} +print """ +

+ + +""" + # This page was super-helpful: # http://jsbeautifier.org/