#!/usr/bin/python
+
+# Generate docs/options.html
+
import json
import glob
import re
+import sys
+
+# Set this to the path to a test file to get debug output for just that test
+# file. Can be helpful to figure out why a test is not being shown for a
+# particular option.
+debug_tests = [] # [ 'tests/zoom.html' ]
# Pull options reference JSON out of dygraph.js
js = ''
in_json = False
-for line in file('dygraph.js'):
+for line in file('dygraph-options-reference.js'):
if '<JSON>' in line:
in_json = True
elif '</JSON>' in line:
# Find text followed by a colon. These won't all be options, but those that
# have the same name as a Dygraph option probably will be.
-prop_re = re.compile(r'\b([a-zA-Z0-9]+):')
-for test_file in glob.glob('tests/*.html'):
+prop_re = re.compile(r'\b([a-zA-Z0-9]+) *:')
+tests = debug_tests or glob.glob('tests/*.html')
+for test_file in tests:
braced_html = find_braces(file(test_file).read())
+ if debug_tests:
+ print braced_html
+
ms = re.findall(prop_re, braced_html)
for opt in ms:
+ if debug_tests: print '\n'.join(ms)
if opt in docs and test_file not in docs[opt]['tests']:
docs[opt]['tests'].append(test_file)
+if debug_tests: sys.exit(0)
+
# Extract a labels list.
labels = []
for nu, opt in docs.iteritems():
<html>
<head>
<title>Dygraphs Options Reference</title>
+ <link rel="stylesheet" href="style.css">
<style type="text/css">
p.option {
padding-left: 25px;
+ }
+ #nav {
+ position: fixed;
+ }
+ #content {
max-width: 800px;
}
</style>
<body>
"""
-print 'Options categories:\n'
-print '<ul>\n'
+print """
+<div id=nav>
+<h2>Dygraphs</h2>
+<ul>
+ <li><a href="index.html">Home</a>
+ <li><a href="data.html">Data Formats</a></li>
+ <li><a href="annotations.html">Annotations</a></li>
+</ul>
+<h2>Options Reference</h2>
+<ul>
+ <li><a href="#usage">Usage</a>
+"""
for label in sorted(labels):
print ' <li><a href="#%s">%s</a>\n' % (label, label)
-print '</ul>\n\n'
+print '</ul>\n</div>\n\n'
def name(f):
"""Takes 'tests/demo.html' -> 'demo'"""
return f.replace('tests/', '').replace('.html', '')
+print """
+<div id=content>
+<h2>Options Reference</h2>
+<p>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.</p>
+
+<a name="usage"><h3>Usage</h3>
+<p>You specify options in the third parameter to the dygraphs constructor:
+<pre>g = new Dygraph(div,
+ data,
+ {
+ option1: value1,
+ option2: value2,
+ ...
+ });
+</pre>
+
+After you've created a Dygraph, you can change an option by calling the <code>updateOptions</code> method:
+<pre>g.updateOptions({
+ new_option1: value1,
+ new_option2: value2
+ });
+</pre>
+
+<p>And, without further ado, here's the complete list of options:</p>
+"""
for label in sorted(labels):
- print '<a name="%s"><h2>%s</h2>\n' % (label, label)
+ print '<a name="%s"><h3>%s</h3>\n' % (label, label)
for opt_name in sorted(docs.keys()):
opt = docs[opt_name]
examples_html = ' '.join(
'<a href="%s">%s</a>' % (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 """
- <p class='option'><b>%(name)s</b><br/>
+ <p class='option'><a name="%(name)s"/><b>%(name)s</b><br/>
%(desc)s<br/>
<i>Type: %(type)s<br/>
Default: %(default)s</i><br/>
'examples_html': examples_html}
+print """
+</div>
+</body>
+</html>
+"""
+
# This page was super-helpful:
# http://jsbeautifier.org/