X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=ddaa68a2e5b2f25188880760223a5ab6dabc0122;hb=6a4457b403f78ba559550f97330ac25ee4d9629f;hp=01dd49551b07212e78c6a8be535c6ae57c1a7baa;hpb=473278ecf6ef632d9104af0c46fc86ae93cfccda;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index 01dd495..ddaa68a 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -53,7 +53,14 @@ def search_files(type, files): # 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: - braced_html = find_braces(file(test_file).read()) + 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 @@ -139,11 +146,11 @@ print """

And, without further ado, here's the complete list of options:

""" -def de_tests(f): +def test_name(f): """Takes 'tests/demo.html' -> 'demo'""" return f.replace('tests/', '').replace('.html', '') -def de_gallery(f): +def gallery_name(f): """Takes 'gallery/demo.js' -> 'demo'""" return f.replace('gallery/', '').replace('.js', '') @@ -163,14 +170,14 @@ for label in sorted(labels): examples_html = 'NONE' else: examples_html = ' '.join( - '%s' % (f, de_tests(f)) for f in tests) + '%s' % (f, test_name(f)) for f in tests) gallery = opt['gallery'] if not gallery: gallery_html = 'NONE' else: gallery_html = ' '.join( - '%s' % (urlify_gallery(f), de_gallery(f)) for f in gallery) + '%s' % (urlify_gallery(f), gallery_name(f)) for f in gallery) if 'parameters' in opt: parameters = opt['parameters'] @@ -185,11 +192,11 @@ for label in sorted(labels): print """
%(name)s
- %(desc)s
+

%(desc)s

Type: %(type)s
%(parameters)s - Default: %(default)s
- Examples: %(examples_html)s
- Gallery: %(gallery_html)s
+ Default: %(default)s

+ Gallery Samples: %(gallery_html)s
+ Other Examples: %(examples_html)s

""" % { 'name': opt_name, 'type': opt['type'],