X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=f6d7d7903c6ec8036c62d2d8ee83610f66ec95b2;hb=335011fd4473f55aaaceb69726d15e0063373149;hp=ddaa68a2e5b2f25188880760223a5ab6dabc0122;hpb=0295cce3d1a0852695121fe29d23fc728d991c43;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index ddaa68a..f6d7d79 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -2,8 +2,9 @@ # Generate docs/options.html -import json import glob +import json +import os import re import sys @@ -53,22 +54,24 @@ 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: - 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) + 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\(" @@ -77,52 +80,36 @@ if debug_tests: sys.exit(0) # Extract a labels list. labels = [] -for nu, opt in docs.iteritems(): +for _, opt in docs.iteritems(): for label in opt['labels']: if label not in labels: labels.append(label) -print """ - - - Dygraphs Options Reference - - - - +print """ + + + + + + """ print """ -\n\n' print """ -
+

Options Reference

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.

@@ -143,6 +130,9 @@ print """ new_option2: value2 }); + +

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.

+

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

""" @@ -215,9 +205,9 @@ Some callbacks take a point argument. Its properties are:
  • canvasx/canvasy: The canvas coordinates at which the point is drawn.
  • name: The name of the data series to which the point belongs
    • -
    - - +
    + + """ # This page was super-helpful: