-
Notifications
You must be signed in to change notification settings - Fork 5
/
docs.py
190 lines (152 loc) · 10.7 KB
/
docs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
import os, yaml, json
from tools import *
URL = 'http://tangrams.github.io/blocks/'
def mainREADME(readmes):
# Compose a the BIG main README.md
with open('README.md', 'w') as outfile:
# Add the intro
with open('INTRO.md') as infile:
outfile.write(infile.read())
# Content
# Add all folder README.md one after the other
outfile.write('\n## Blocks description\n<hr>\n')
for fname in readmes:
with open(fname) as infile:
folder = os.path.dirname(fname)[2:]
outfile.write('\n\n### [' + folder.upper() + ']('+URL+'#'+folder+') <a href="https://github.com/tangrams/blocks/blob/gh-pages/'+folder+'" target="_blank"><i class="fa fa-github" aria-hidden="true"></i></a>')
outfile.write(infile.read())
outfile.write('\n\n')
# Add the License at the end
with open('LICENSE.md') as infile:
outfile.write(infile.read())
def appendDoc2README(readme_file, filename, counter):
toc_of_blocks = []
folder = os.path.dirname(filename)
yaml_file = yaml.safe_load(open(filename))
# For each style ('styles') in this yaml_file
for block_name in yaml_file['styles']:
block = yaml_file['styles'][block_name]
if counter != 0:
readme_file.write('\n\n')
# Add a title that points to github
readme_file.write('\n\n#### [' + block_name + ']('+URL+'#'+block_name+') <a href="https://github.com/tangrams/blocks/blob/gh-pages'+filename[1:]+'" target="_blank"><i class="fa fa-github" aria-hidden="true"></i></a>\n\n');
toc_of_blocks.append(block_name)
# Add a description if it have
if isDocumentationIn(block):
readme_file.write(getDescriptionOf(block))
# Add an explanation of how to import this block
readme_file.write( '\n\nTo import this block add the following url to your `import` list:\n\n' +
'```yaml\n' +
'import:\n' +
' - https://tangrams.github.io/blocks/' + filename[2:] + '\n' +
'```\n\n\n')
# Add an explanation of how to import this block with dependencies
readme_file.write( '\n\nIf you want to import this block together **with their dependencies** use this other url:\n\n' +
'```yaml\n' +
'import:\n' +
' - https://tangrams.github.io/blocks/' + filename[2:-5] + '-full.yaml\n' +
'```\n\n\n')
if isShaderIn(block):
readme_file.write('These blocks uses a custom **shader**.\n');
shader = block['shaders']
# Add a list of uniforms
if isUniformsIn(block):
readme_file.write('These are the **uniforms**:\n')
for uniform_name in shader['uniforms'].keys():
uniform_doc = ' **' + uniform_name + '**: '
# Add extra information from the UI
if uniformHaveMetadata(uniform_name, block):
uniform_metadata = block['ui']['shaders']['uniforms'][uniform_name]
uniform_label = uniform_metadata['label'].lower()
if uniform_metadata['type'] == 'number':
uniform_doc += ' number between ```' + str(uniform_metadata['range']['min']) + '``` and ```' + str(uniform_metadata['range']['max']) + '``` that control the *' + uniform_label + '*.'
elif uniform_metadata['type'] == 'dropdownArray':
uniform_doc += ' variable that control the *' + uniform_label + '* with one of the following values: ```'
uniform_doc += ', '.join(uniform_metadata['values']) + '```.'
elif uniform_metadata['type'] == 'dropdownList':
uniform_doc += ' variable that control the *' + uniform_label + '* with one of the following values: '
uniform_values = []
for key, value in uniform_metadata['values'].iteritems():
uniform_values.append('```'+value+'``` ( *' + key + '* )')
uniform_doc += ', '.join(uniform_values) + '.'
uniform_doc += ' The *default value* is ```' + str(shader['uniforms'][uniform_name]) + '```. '
readme_file.write(' - ' + uniform_doc + '\n')
readme_file.write('\n')
# Add a list of defines
if isDefinesIn(block):
readme_file.write('These are the **defines**:\n')
for define_name in shader['defines'].keys():
define_doc = ' **' + define_name + '**: ' # name
# Add extra information from the UI
if defineHaveMetadata(define_name, block):
define_metadata = block['ui']['shaders']['defines'][define_name]
define_label = define_metadata['label'].lower()
if define_metadata['type'] == 'number':
define_doc += ' number between ```' + str(define_metadata['range']['min']) + '``` and ```' + str(define_metadata['range']['max']) + '``` that control the *' + define_label + '*.'
elif define_metadata['type'] == 'dropdownArray':
define_doc += ' variable that control the *' + define_label + '* with one of the following values: ```'
define_doc += ', '.join(define_metadata['values']) + '```.'
elif define_metadata['type'] == 'dropdownList':
define_doc += ' variable that control the *' + define_label + '* with one of the following values: '
define_values = []
for key, value in define_metadata['values'].iteritems():
define_values.append('```'+value+'``` ( *' + key + '* )')
define_doc += ', '.join(define_values) + '.'
define_doc += ' The *default value* is ```' + str(shader['defines'][define_name]) + '```. '
readme_file.write(' - ' + define_doc + '\n')
readme_file.write('\n')
# Add a list of blocks
if isShaderBlocksIn(block):
readme_file.write('These are the **shader blocks**:\n');
global_fncs = getGlobalFunctionsIn(block)
if len(global_fncs):
readme_file.write('\n- **global**:')
for function in global_fncs:
readme_file.write('\n + `' + function[1]+ ' ' + function[2] + function[4] + '`')
for block_type in block['shaders']['blocks'].keys():
# In case of a 'global' block... just list the functions it contain
if block_type != 'global':
readme_file.write('\n- **' + block_type + '**:')
readme_file.write( '\n\n```glsl\n' +
block['shaders']['blocks'][block_type] +
'\n```\n\n')
readme_file.write('\n')
if isTestIn(block):
benchmark_image = folder+'/test/'+block_name+'.png'
benchmark_json = folder+'/test/'+block_name+'.json'
if os.path.isfile(benchmark_image) and os.path.isfile(benchmark_json):
readme_file.write('\nHere are some **benchmarks** of this block performed on a Raspberry Pi:\n');
readme_file.write('[]('+URL+'test.html?test='+benchmark_json+')\n')
# For each test
with open(benchmark_json) as data_file:
benchmark_data = json.load(data_file)
for test_name in block['test']:
readme_file.write('\n- **'+test_name+'**')
if block_name in benchmark_data:
if test_name in benchmark_data[block_name]:
readme_file.write(' ( mean: ' + str(benchmark_data[block_name][test_name]['mean']) +
' median: ' + str(benchmark_data[block_name][test_name]['median']) + ' )')
readme_file.write('\n\n')
readme_file.write('<a href="http://thebookofshaders.com/edit.php#'+URL+benchmark_data[block_name][test_name]['output'][:-3]+'frag"><img src="'+URL+benchmark_data[block_name][test_name]['output']+'" style="width:100px; height:100px; float: right; left: 55px;"></a>')
if 'blocks' in block['test'][test_name]:
readme_file.write('\n\n```glsl\n')
if 'defines' in block['test'][test_name]:
for define in block['test'][test_name]['defines']:
readme_file.write('#define '+define+' '+str(block['test'][test_name]['defines'][define])+'\n')
if 'color' in block['test'][test_name]['blocks']:
readme_file.write('...\n// Color:\n')
readme_file.write(block['test'][test_name]['blocks']['color'])
readme_file.write('\n```\n\n')
# Add a list of examples
if isExamplesIn(block):
readme_file.write('\nExamples:\n');
for example in block['doc']['examples']:
if 'url' in block['doc']['examples'][example]:
url = 'https://mapzen.com/tangram/play/?scene=' + block['doc']['examples'][example]['url']
if 'lines' in block['doc']['examples'][example]:
url = url + '&lines=' + str(block['doc']['examples'][example]['lines'])
if 'img' in block['doc']['examples'][example]:
readme_file.write('<a href="'+url+'" target="_blank">\n<img src="'+block['doc']['examples'][example]['img']+'" style="width: 100%; height: 100px; object-fit: cover;">\n</a>\n')
else:
readme_file.write('<a href="'+url+'" target="_blank">'+example+'</a>\n')
return toc_of_blocks