X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=scripts%2Fgenerate-documentation.py;fp=scripts%2Fgenerate-documentation.py;h=31781b914574538f27e2a44320f544aad6b6ec27;hb=2ef8997fe939afdfd7c2c09c393a3073897633bd;hp=0000000000000000000000000000000000000000;hpb=3cb508ec79690565988005df9bd0b7af8059fb01;p=dygraphs.git
diff --git a/scripts/generate-documentation.py b/scripts/generate-documentation.py
new file mode 100755
index 0000000..31781b9
--- /dev/null
+++ b/scripts/generate-documentation.py
@@ -0,0 +1,219 @@
+#!/usr/bin/env python
+
+# Generate docs/options.html
+
+import glob
+import json
+import os
+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-options-reference.js'):
+ if '' in line:
+ in_json = True
+ elif '' in line:
+ in_json = False
+ elif in_json:
+ js += line
+
+# TODO(danvk): better errors here.
+assert js
+docs = json.loads(js)
+
+# Go through the tests and find uses of each option.
+for opt in docs:
+ docs[opt]['tests'] = []
+ docs[opt]['gallery'] = []
+
+# 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. '{'. """
+ out = ''
+ level = 0
+ for char in txt:
+ if char == '{':
+ level += 1
+ if level >= 1:
+ out += char
+ if char == '}':
+ level -= 1
+ return out
+
+def search_files(type, files):
+ # 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 files:
+ if os.path.isfile(test_file): # Basically skips directories
+ text = file(test_file).read()
+
+ # Hack for slipping past gallery demos that have title in their attributes
+ # so they don't appear as reasons for the demo to have 'title' options.
+ if type == "gallery":
+ idx = text.find("function(")
+ if idx >= 0:
+ text = text[idx:]
+ braced_html = find_braces(text)
+ 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][type]:
+ docs[opt][type].append(test_file)
+
+search_files("tests", glob.glob("tests/*.html"))
+search_files("gallery", glob.glob("gallery/*.js")) #TODO add grep "Gallery.register\("
+
+if debug_tests: sys.exit(0)
+
+# Extract a labels list.
+labels = []
+for _, opt in docs.iteritems():
+ for label in opt['labels']:
+ if label not in labels:
+ labels.append(label)
+
+print """
+
+
+
+
+
+
+"""
+
+print """
+
+
+
+
Usage
+"""
+for label in sorted(labels):
+ 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.
+
+
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:
Some options can be set on a per-axis and per-series basis. See the docs on per-axis and per-series options to learn how to do this. The options which may be set in this way are marked as such on this page.
+
+
For options which are functions (e.g. callbacks and formatters), the value of this is set to the Dygraph object.
+
+
And, without further ado, here's the complete list of options: