X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=2dd5b9847cfb6d810233b559799ac17c8df0df1e;hb=3c10a0f3519355ee651d04bf2972bd31298eff18;hp=3e88088e6e510cf96b4a0a44c281e427cb8d4a51;hpb=5af2de242af305c2d17d5316f52ea7316bad67f3;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index 3e88088..2dd5b98 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -1,12 +1,21 @@ -#!/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: @@ -40,14 +49,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(): @@ -138,7 +154,7 @@ for label in sorted(labels): if not opt['description']: opt['description'] = '(missing)' print """ -

%(name)s
+

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