X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=613dec73940f7c2f11cb6d5fa625e28dd1c67209;hb=bceff4bfe5fc77816c5c6f0025e38debfbfbfd0a;hp=155393b8a32912604f4d80e0b881cc4c56af6ae4;hpb=b5f3dd4ea60fc30192b8cc2f80e51dfea2029c18;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index 155393b..613dec7 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -1,17 +1,28 @@ -#!/usr/bin/python +#!/usr/bin/env 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: in_json = False elif in_json: + if line.endswith("\\\n"): # hacked in line continuation support with trailing \. + line = line[:-2] js += line # TODO(danvk): better errors here. @@ -40,14 +51,21 @@ def find_braces(txt): # 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(): @@ -55,7 +73,7 @@ for nu, opt in docs.iteritems(): if label not in labels: labels.append(label) -print """ +print """ Dygraphs Options Reference @@ -64,6 +82,9 @@ print """ p.option { padding-left: 25px; } + div.parameters { + padding-left: 15px; + } #nav { position: fixed; } @@ -76,7 +97,7 @@ print """ """ print """ -