[dygraphs.git] / generate-documentation.py

#!/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-options-reference.js'):
  if '<JSON>' in line:
    in_json = True
  elif '</JSON>' 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'] = []

# 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

# 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]+) *:')
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():
  for label in opt['labels']:
    if label not in labels:
      labels.append(label)

print """
<html>
<head>
  <title>Dygraphs Options Reference</title>
  <link rel="stylesheet" href="style.css">
  <style type="text/css">
    p.option {
      padding-left: 25px;
    }
    #nav {
      position: fixed;
    }
    #content {
      max-width: 800px;
    }
  </style>
</head>
<body>
"""

print """
<div id=nav>
<h2>Dygraphs</h2>
<ul>
  <li><a href="index.html">Home</a>
  <li><a href="data.html">Data Formats</a></li>
  <li><a href="annotations.html">Annotations</a></li>
</ul>
<h2>Options Reference</h2>
<ul>
  <li><a href="#usage">Usage</a>
"""
for label in sorted(labels):
  print '  <li><a href="#%s">%s</a>\n' % (label, label)
print '</ul>\n</div>\n\n'

def name(f):
  """Takes 'tests/demo.html' -> 'demo'"""
  return f.replace('tests/', '').replace('.html', '')

print """
<div id=content>
<h2>Options Reference</h2>
<p>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.</p>

<a name="usage"><h3>Usage</h3>
<p>You specify options in the third parameter to the dygraphs constructor:
<pre>g = new Dygraph(div,
                data,
                {
                  option1: value1,
                  option2: value2,
                  ...
                });
</pre>

After you've created a Dygraph, you can change an option by calling the <code>updateOptions</code> method:
<pre>g.updateOptions({
                  new_option1: value1,
                  new_option2: value2
                });
</pre>

<p>And, without further ado, here's the complete list of options:</p>
"""
for label in sorted(labels):
  print '<a name="%s"><h3>%s</h3>\n' % (label, label)

  for opt_name in sorted(docs.keys()):
    opt = docs[opt_name]
    if label not in opt['labels']: continue
    tests = opt['tests']
    if not tests:
      examples_html = '<font color=red>NONE</font>'
    else:
      examples_html = ' '.join(
        '<a href="%s">%s</a>' % (f, name(f)) for f in tests)

    if not opt['type']: opt['type'] = '(missing)'
    if not opt['default']: opt['default'] = '(missing)'
    if not opt['description']: opt['description'] = '(missing)'

    print """
  <p class='option'><a name="%(name)s"/><b>%(name)s</b><br/>
  %(desc)s<br/>
  <i>Type: %(type)s<br/>
  Default: %(default)s</i><br/>
  Examples: %(examples_html)s<br/>
  <br/>
  """ % { 'name': opt_name,
          'type': opt['type'],
          'default': opt['default'],
          'desc': opt['description'],
          'examples_html': examples_html}


print """
</div>
</body>
</html>
"""

# This page was super-helpful:
# http://jsbeautifier.org/
Commit	Line	Data
db071c3e	1	#!/usr/bin/env python
ea910bfa RK	2
	3	# Generate docs/options.html
	4
0e37f8e5 DV	5	import json
	6	import glob
	7	import re
d1d19c3e DV	8	import sys
	9
	10	# Set this to the path to a test file to get debug output for just that test
	11	# file. Can be helpful to figure out why a test is not being shown for a
	12	# particular option.
	13	debug_tests = [] # [ 'tests/zoom.html' ]
0e37f8e5	14
88b1e052	15	# Pull options reference JSON out of dygraph.js
0e37f8e5 DV	16	js = ''
0e37f8e5 DV	17	in_json = False
730852d8	18	for line in file('dygraph-options-reference.js'):
0e37f8e5 DV	19	if '<JSON>' in line:
	20	in_json = True
	21	elif '</JSON>' in line:
	22	in_json = False
	23	elif in_json:
	24	js += line
	25
	26	# TODO(danvk): better errors here.
	27	assert js
	28	docs = json.loads(js)
	29
	30	# Go through the tests and find uses of each option.
	31	for opt in docs:
	32	docs[opt]['tests'] = []
	33
88b1e052 DV	34	# This is helpful for differentiating uses of options like 'width' and 'height'
88b1e052 DV	35	# from appearances of identically-named options in CSS.
0e37f8e5 DV	36	def find_braces(txt):
	37	"""Really primitive method to find text inside of {..} braces.
	38	Doesn't work if there's an unmatched brace in a string, e.g. '{'. """
	39	out = ''
	40	level = 0
	41	for char in txt:
	42	if char == '{':
	43	level += 1
	44	if level >= 1:
	45	out += char
	46	if char == '}':
	47	level -= 1
	48	return out
	49
88b1e052 DV	50	# Find text followed by a colon. These won't all be options, but those that
88b1e052 DV	51	# have the same name as a Dygraph option probably will be.
d1d19c3e DV	52	prop_re = re.compile(r'\b([a-zA-Z0-9]+) *:')
	53	tests = debug_tests or glob.glob('tests/*.html')
	54	for test_file in tests:
0e37f8e5	55	braced_html = find_braces(file(test_file).read())
d1d19c3e DV	56	if debug_tests:
	57	print braced_html
	58
0e37f8e5 DV	59	ms = re.findall(prop_re, braced_html)
0e37f8e5 DV	60	for opt in ms:
d1d19c3e	61	if debug_tests: print '\n'.join(ms)
0e37f8e5 DV	62	if opt in docs and test_file not in docs[opt]['tests']:
	63	docs[opt]['tests'].append(test_file)
	64
d1d19c3e DV	65	if debug_tests: sys.exit(0)
d1d19c3e DV	66
a38e9336 DV	67	# Extract a labels list.
	68	labels = []
	69	for nu, opt in docs.iteritems():
	70	for label in opt['labels']:
	71	if label not in labels:
	72	labels.append(label)
	73
	74	print """
	75	<html>
	76	<head>
	77	<title>Dygraphs Options Reference</title>
5af2de24	78	<link rel="stylesheet" href="style.css">
a38e9336 DV	79	<style type="text/css">
	80	p.option {
	81	padding-left: 25px;
5af2de24 DV	82	}
	83	#nav {
	84	position: fixed;
	85	}
	86	#content {
a38e9336 DV	87	max-width: 800px;
	88	}
	89	</style>
	90	</head>
	91	<body>
	92	"""
	93
5af2de24 DV	94	print """
	95	<div id=nav>
	96	<h2>Dygraphs</h2>
	97	<ul>
	98	<li><a href="index.html">Home</a>
	99	<li><a href="data.html">Data Formats</a></li>
	100	<li><a href="annotations.html">Annotations</a></li>
	101	</ul>
	102	<h2>Options Reference</h2>
	103	<ul>
	104	<li><a href="#usage">Usage</a>
	105	"""
a38e9336 DV	106	for label in sorted(labels):
a38e9336 DV	107	print ' <li><a href="#%s">%s</a>\n' % (label, label)
5af2de24	108	print '</ul>\n</div>\n\n'
a38e9336	109
0e37f8e5	110	def name(f):
88b1e052	111	"""Takes 'tests/demo.html' -> 'demo'"""
0e37f8e5 DV	112	return f.replace('tests/', '').replace('.html', '')
0e37f8e5 DV	113
5af2de24 DV	114	print """
	115	<div id=content>
	116	<h2>Options Reference</h2>
	117	<p>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.</p>
	118
	119	<a name="usage"><h3>Usage</h3>
	120	<p>You specify options in the third parameter to the dygraphs constructor:
	121	<pre>g = new Dygraph(div,
	122	data,
	123	{
	124	option1: value1,
	125	option2: value2,
	126	...
	127	});
	128	</pre>
	129
	130	After you've created a Dygraph, you can change an option by calling the <code>updateOptions</code> method:
	131	<pre>g.updateOptions({
	132	new_option1: value1,
	133	new_option2: value2
	134	});
	135	</pre>
	136
	137	<p>And, without further ado, here's the complete list of options:</p>
	138	"""
a38e9336	139	for label in sorted(labels):
5af2de24	140	print '<a name="%s"><h3>%s</h3>\n' % (label, label)
a38e9336 DV	141
	142	for opt_name in sorted(docs.keys()):
	143	opt = docs[opt_name]
	144	if label not in opt['labels']: continue
	145	tests = opt['tests']
	146	if not tests:
	147	examples_html = '<font color=red>NONE</font>'
	148	else:
	149	examples_html = ' '.join(
	150	'<a href="%s">%s</a>' % (f, name(f)) for f in tests)
	151
5af2de24 DV	152	if not opt['type']: opt['type'] = '(missing)'
	153	if not opt['default']: opt['default'] = '(missing)'
	154	if not opt['description']: opt['description'] = '(missing)'
	155
a38e9336	156	print """
b5f3dd4e	157	<p class='option'><a name="%(name)s"/><b>%(name)s</b><br/>
a38e9336 DV	158	%(desc)s<br/>
	159	<i>Type: %(type)s<br/>
	160	Default: %(default)s</i><br/>
	161	Examples: %(examples_html)s<br/>
	162	<br/>
	163	""" % { 'name': opt_name,
	164	'type': opt['type'],
	165	'default': opt['default'],
	166	'desc': opt['description'],
	167	'examples_html': examples_html}
0e37f8e5	168
0e37f8e5	169
5af2de24 DV	170	print """
	171	</div>
	172	</body>
	173	</html>
	174	"""
	175
a38e9336 DV	176	# This page was super-helpful:
a38e9336 DV	177	# http://jsbeautifier.org/