X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;ds=sidebyside;f=generate-documentation.py;h=2f91503500fee20986a72c4980a03b388b341255;hb=e6e12f189a4d828530bab7607ce42ea56283d810;hp=5b6400f35b38710f63dae18fee99f3b41c8ae245;hpb=0e37f8e5b44d3e747be8ad87fa47cc734a630626;p=dygraphs.git
diff --git a/generate-documentation.py b/generate-documentation.py
index 5b6400f..2f91503 100755
--- a/generate-documentation.py
+++ b/generate-documentation.py
@@ -1,11 +1,21 @@
#!/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 '' in line:
in_json = True
elif '' in line:
@@ -21,6 +31,8 @@ docs = json.loads(js)
for opt in docs:
docs[opt]['tests'] = []
+# This is helpful for differentiating uses of options like 'width' and 'height'
+# from appearances of identically-named options in CSS.
def find_braces(txt):
"""Really primitive method to find text inside of {..} braces.
Doesn't work if there's an unmatched brace in a string, e.g. '{'. """
@@ -35,36 +47,131 @@ def find_braces(txt):
level -= 1
return out
-prop_re = re.compile(r'\b([a-zA-Z]+):')
-for test_file in glob.glob('tests/*.html'):
+# 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]+) *:')
+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():
+ for label in opt['labels']:
+ if label not in labels:
+ labels.append(label)
+
+print """
+
+
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.