forked from ArduPilot/ardupilot_wiki
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathupdate.py
executable file
·1086 lines (924 loc) · 38.6 KB
/
update.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
This script updates and rebuilds wiki sources from Github and from
parameters on the test server.
It is intended to be run on the main wiki server or
locally within the project's Vagrant environment.
Build notes:
* First step is always a fetch and pull from git (master).
* Default is just a normal fetch and pull from master
* If the --clean option is "True" then git will reset to head
* Common topics are copied from /common/source/docs.
* Topics are copied based on information in the copywiki shortcode.
For example a topic marked as below would only be copied to copter
and plane wikis:
[copywiki destination="copter,plane"]
* Topics that don't have a [copywiki] will be copied to wikis
the DEFAULT_COPY_WIKIS list
* Copied topics are stripped of the 'copywiki' shortcode in the destination.
* Copied topics are stripped of any content not marked for the target wiki
using the "site" shortcode:
[site wiki="plane,rover"]conditional content[/site]
Parameters files are fetched from autotest using a Wget
"""
from __future__ import print_function, unicode_literals
import argparse
import distutils
import errno
import filecmp
import json
import glob
import gzip
import hashlib
import multiprocessing
import os
import platform
import re
import shutil
import subprocess
import sys
import time
import rst_table
from codecs import open
from datetime import datetime
# while flake8 says this is unused, distutils.dir_util.mkpath fails
# without the following import on old versions of Python:
from distutils import dir_util # noqa: F401
if sys.version_info < (3, 8):
print("Minimum python version is 3.8")
sys.exit(1)
DEFAULT_COPY_WIKIS = ['copter', 'plane', 'rover']
ALL_WIKIS = [
'copter',
'plane',
'rover',
'antennatracker',
'dev',
'planner',
'planner2',
'ardupilot',
'mavproxy',
'frontend',
'blimp',
]
COMMON_DIR = 'common'
WIKI_NAME_TO_VEHICLE_NAME = {
'copter': 'Copter',
'plane': 'Plane',
'rover': 'Rover',
'blimp': 'Blimp',
}
# GIT_REPO = ''
PARAMETER_SITE = {
'rover': 'APMrover2',
'copter': 'ArduCopter',
'plane': 'ArduPlane',
'antennatracker': 'AntennaTracker',
'AP_Periph': 'AP_Periph',
'blimp': 'Blimp',
}
LOGMESSAGE_SITE = {
'rover': 'Rover',
'copter': 'Copter',
'plane': 'Plane',
'antennatracker': 'Tracker',
'blimp': 'Blimp',
}
error_log = list()
N_BACKUPS_RETAIN = 10
VERBOSE = False
def debug(str_to_print):
"""Debug output if verbose is set."""
if VERBOSE:
print("[update.py] " + str_to_print)
def error(str_to_print):
"""Show and count the errors."""
global error_log
error_log.append(str_to_print)
print(f"[update.py][error]: {str_to_print}", file=sys.stderr)
def fatal(str_to_print):
"""Show and count the errors."""
error(str_to_print)
sys.exit(1)
def remove_if_exists(filepath):
try:
os.remove(filepath)
except OSError as e:
if e.errno != errno.ENOENT:
raise e
def fetch_url(fetchurl):
'''fetches content at url and puts it in a file corresponding to the filename in the URL'''
if platform.system() == "Windows":
subprocess.check_call(["powershell.exe", "Start-BitsTransfer", "-Source", fetchurl])
else:
subprocess.check_call(["wget", fetchurl])
def fetchparameters(site=None, cache=None):
"""Fetches the parameters for all the sites from the test server and
copies them to the correct location.
This is always run as part of a build (i.e. no checking to see if
parameters have changed.)
"""
# remove any parameters files in root
remove_if_exists('Parameters.rst')
for key, value in PARAMETER_SITE.items():
fetchurl = 'https://autotest.ardupilot.org/Parameters/%s/Parameters.rst' % value
targetfile = './%s/source/docs/parameters.rst' % key
if key == 'AP_Periph':
targetfile = './dev/source/docs/AP_Periph-Parameters.rst'
if cache:
if not os.path.exists(targetfile):
raise Exception("Asked to use cached parameter files, but (%s) does not exist" % (targetfile,))
continue
if site == key or site is None:
fetch_url(fetchurl)
# move in new file
if os.path.exists(targetfile):
os.unlink(targetfile)
os.rename('Parameters.rst', targetfile)
def fetchlogmessages(site=None, cache=None):
"""
Fetches the parameters for all the sites from the autotest server and
copies them to the correct location.
This is always run as part of a build (i.e. no checking to see if
logmessages have changed.)
"""
for key, value in LOGMESSAGE_SITE.items():
fetchurl = 'https://autotest.ardupilot.org/LogMessages/%s/LogMessages.rst' % value
targetfile = './%s/source/docs/logmessages.rst' % key
if cache:
if not os.path.exists(targetfile):
raise Exception("Asked to use cached parameter files, but (%s) does not exist" % (targetfile,))
continue
if site == key or site is None:
fetch_url(fetchurl)
# move in new file
if os.path.exists(targetfile):
os.unlink(targetfile)
os.rename('LogMessages.rst', targetfile)
def build_one(wiki, fast):
'''build one wiki'''
debug('Using make for sphinx: %s' % wiki)
if platform.system() == "Windows":
# This will fail if there's no folder to clean, so no check_call here
if not fast:
subprocess.run(["make.bat", "clean"], cwd=wiki, shell=True)
subprocess.check_call(["make.bat", "html"], cwd=wiki, shell=True)
else:
if not fast:
subprocess.check_call(["nice", "make", "clean"], cwd=wiki)
subprocess.check_call(["nice", "make", "html"], cwd=wiki)
def sphinx_make(site, parallel, fast):
"""
Calls 'make html' to build each site
"""
done = set()
wikis = set(ALL_WIKIS[:])
procs = []
while len(done) != len(wikis):
wiki = list(wikis.difference(done))[0]
done.add(wiki)
if site == 'common' or site == 'frontend':
continue
if wiki == 'frontend' :
continue
if site is not None and not site == wiki:
continue
p = multiprocessing.Process(target=build_one, args=(wiki, fast))
p.start()
procs.append(p)
while parallel != -1 and len(procs) >= parallel:
for p in procs:
if p.exitcode is not None:
p.join()
procs.remove(p)
if p.exitcode != 0:
error('Error making sphinx(1)')
time.sleep(0.1)
while len(procs) > 0:
for p in procs[:]:
if p.exitcode is not None:
p.join()
procs.remove(p)
if p.exitcode != 0:
error('Error making sphinx(2)')
time.sleep(0.1)
def check_build(site):
"""
check that build was successful
"""
if platform.system() == "Windows":
debug("Skipping check_build on windows")
return
for wiki in ALL_WIKIS:
if site is not None and site != wiki:
continue
if wiki in ['common', 'frontend']:
continue
index_html = os.path.join(wiki, "build", "html", "index.html")
if not os.path.exists(index_html):
fatal("%s site not built - missing %s" % (wiki, index_html))
def copy_build(site, destdir):
"""
Copies each site into the target location
"""
for wiki in ALL_WIKIS:
if site == 'common':
continue
if site is not None and site != wiki:
continue
if wiki == 'frontend':
continue
debug('Copy: %s' % wiki)
targetdir = os.path.join(destdir, wiki)
debug("Creating backup")
olddir = os.path.join(destdir, 'old')
debug('Recreating %s' % olddir)
if os.path.exists(olddir):
shutil.rmtree(olddir)
os.makedirs(olddir)
if os.path.exists(targetdir):
debug('Moving %s into %s' % (targetdir, olddir))
shutil.move(targetdir, olddir)
# copy new dir to targetdir
# print("DEBUG: targetdir: %s" % targetdir)
# sourcedir='./%s/build/html/*' % wiki
sourcedir = './%s/build/html/' % wiki
# print("DEBUG: sourcedir: %s" % sourcedir)
# print('DEBUG: mv %s %s' % (sourcedir, destdir) )
html_moved_dir = os.path.join(destdir, 'html')
try:
shutil.move(sourcedir, html_moved_dir)
# Rename move! (single move to html/* failed)
shutil.move(html_moved_dir, targetdir)
debug("Moved to %s" % targetdir)
except Exception: # FIXME: narrow exception type
error("FAIL moving output to %s" % targetdir)
# copy jquery
os.makedirs(os.path.join(targetdir, '_static'), exist_ok=True)
shutil.copy(os.path.join('js', 'jquery-3.2.1.min.js'), os.path.join(targetdir, '_static', 'jquery-3.2.1.min.js'))
# delete the old directory
debug('Removing %s' % olddir)
shutil.rmtree(olddir)
def make_backup(site, destdir, backupdestdir):
"""
backup current site
"""
for wiki in ALL_WIKIS:
if site == 'common':
continue
if site is not None and site != wiki:
continue
if wiki == 'frontend':
continue
debug('Backing up: %s' % wiki)
targetdir = os.path.join(destdir, wiki)
distutils.dir_util.mkpath(targetdir)
if not os.path.exists(targetdir):
fatal("FAIL backup when looking for folder %s" % targetdir)
bkdir = os.path.join(backupdestdir, str(building_time + '-wiki-bkp'), str(wiki))
debug('Checking %s' % bkdir)
distutils.dir_util.mkpath(bkdir)
debug('Copying %s into %s' % (targetdir, bkdir))
try:
subprocess.check_call(["rsync", "-a", "--delete", targetdir + "/", bkdir])
except subprocess.CalledProcessError as ex:
print(ex)
fatal("Failed to backup %s" % wiki)
def delete_old_wiki_backups(folder, n_to_keep):
try:
debug('Checking number of backups in folder %s' % folder)
backup_folders = glob.glob(folder + "/*-wiki-bkp/")
backup_folders.sort()
if len(backup_folders) > n_to_keep:
for i in range(0, len(backup_folders) - n_to_keep):
if '-wiki-bkp' in str(backup_folders[i]):
debug('Deleting folder %s' % str(backup_folders[i]))
shutil.rmtree(str(backup_folders[i]))
else:
debug('Ignoring folder %s because it does not look like a auto generated wiki backup folder' %
str(backup_folders[i]))
else:
debug('No old backups to delete in %s' % folder)
except Exception as e:
error('Error on deleting some previous wiki backup folders: %s' % e)
def generate_copy_dict(start_dir=COMMON_DIR):
"""
This creates a dict which indexes copy targets for all common docs.
"""
# Clean existing common topics (easiest way to guarantee old ones
# are removed)
# Cost is that these will have to be rebuilt even if not changed
import glob
for wiki in ALL_WIKIS:
files = glob.glob('%s/source/docs/common-*.rst' % wiki)
for f in files:
debug('Remove existing common: %s' % f)
os.remove(f)
# Create destination folders that might be needed (if don't exist)
for wiki in ALL_WIKIS:
try:
os.mkdir(wiki)
except Exception: # FIXME: narrow exception type
pass
try:
os.mkdir('%s/source' % wiki)
except Exception: # FIXME: narrow exception type
pass
try:
os.mkdir('%s/source/docs' % wiki)
except Exception: # FIXME: narrow exception type
pass
try:
os.mkdir('%s/source/_static' % wiki)
except Exception: # FIXME: narrow exception type
pass
for root, dirs, files in os.walk(start_dir):
for file in files:
if file.endswith(".rst"):
debug("FILE: %s" % file)
source_file_path = os.path.join(root, file)
source_file = open(source_file_path, 'r', 'utf-8')
source_content = source_file.read()
source_file.close()
targets = get_copy_targets(source_content)
# print(targets)
for wiki in targets:
# print("CopyTarget: %s" % wiki)
content = strip_content(source_content, wiki)
targetfile = '%s/source/docs/%s' % (wiki, file)
debug(targetfile)
destination_file = open(targetfile, 'w', 'utf-8')
destination_file.write(content)
destination_file.close()
elif file.endswith(".css"):
for wiki in ALL_WIKIS:
shutil.copy2(os.path.join(root, file),
'%s/source/_static/' % wiki)
elif file.endswith(".js"):
source_file_path = os.path.join(root, file)
source_file = open(source_file_path, 'r', 'utf-8')
source_content = source_file.read()
source_file.close()
targets = get_copy_targets(source_content)
# print("JS: " + str(targets))
for wiki in targets:
content = strip_content(source_content, wiki)
targetfile = '%s/source/_static/%s' % (wiki, file)
debug(targetfile)
destination_file = open(targetfile, 'w', 'utf-8')
destination_file.write(content)
destination_file.close()
def get_copy_targets(content):
p = re.compile(r'\[copywiki.*?destination\=\"(.*?)\".*?\]', flags=re.S)
m = p.search(content)
targetset = set()
if m:
targets = m.group(1).split(',')
for item in targets:
targetset.add(item.strip())
else:
targetset = set(DEFAULT_COPY_WIKIS)
return targetset
def strip_content(content, site):
"""
Strips the copywiki shortcode. Removes content for other sites and
the [site] shortcode itself.
"""
def fix_copywiki_shortcode(matchobj):
"""
Strip the copywiki shortcode if found (just return "nothing" to
result of re)
"""
# logmatch_code(matchobj, 'STRIP')
# print("STRIPPED")
return ''
# Remove the copywiki from content
newText = re.sub(r'\[copywiki.*?\]',
fix_copywiki_shortcode,
content,
flags=re.M)
def fix_site_shortcode(matchobj):
# logmatch_code(matchobj, 'SITESC_')
sitelist = matchobj.group(1)
# print("SITES_BLOCK: %s" % sitelist)
if site not in sitelist:
# print("NOT")
return ''
else:
# print("YES")
return matchobj.group(2)
# Remove the site shortcode from content
newText = re.sub(r'\[site\s.*?wiki\=\"(.*?)\".*?\](.*?)\[\/site\]',
fix_site_shortcode,
newText,
flags=re.S)
return newText
def logmatch_code(matchobj, prefix):
try:
print("%s m0: %s" % (prefix, matchobj.group(0)))
except Exception: # FIXME: narrow exception type
print("%s: except m0" % prefix)
try:
print("%s m1: %s" % (prefix, matchobj.group(1)))
except Exception: # FIXME: narrow exception type
print("%s: except m1" % prefix)
try:
print("%s m2: %s" % (prefix, matchobj.group(2)))
except Exception: # FIXME: narrow exception type
print("%s: except m1" % prefix)
try:
print("%s m3: %s" % (prefix, matchobj.group(3)))
except Exception: # FIXME: narrow exception type
print("%s: except m3" % prefix)
try:
print("%s m4: %s" % (prefix, matchobj.group(4)))
except Exception: # FIXME: narrow exception type
print("%s: except m4" % prefix)
try:
print("%s m5: %s" % (prefix, matchobj.group(5)))
except Exception: # FIXME: narrow exception type
print("%s: except m5" % prefix)
try:
print("%s m6: %s" % (prefix, matchobj.group(6)))
except Exception: # FIXME: narrow exception type
print("%s: except m6" % prefix)
try:
print("%s m7: %s" % (prefix, matchobj.group(7)))
except Exception: # FIXME: narrow exception type
print("%s: except 7" % prefix)
try:
print("%s m8: %s" % (prefix, matchobj.group(8)))
except Exception: # FIXME: narrow exception type
print("%s: except m8" % prefix)
def is_the_same_file(file1, file2):
""" Compare two files using their SHA256 hashes"""
digests = []
for filename in [file1, file2]:
hasher = hashlib.sha256()
with open(filename, 'rb') as f:
buf = f.read()
hasher.update(buf)
a = hasher.hexdigest()
digests.append(a)
return digests[0] == digests[1]
def fetch_versioned_parameters(site=None):
"""
It relies on "build_parameters.py" be executed before the "update.py"
Once the generated files are on ../new_params_mversion it tut all
parameters and JSON files in their destinations.
"""
for key, value in PARAMETER_SITE.items():
if key == 'AP_Periph': # workaround until create a versioning for AP_Periph in firmware server
fetchurl = 'https://autotest.ardupilot.org/Parameters/%s/Parameters.rst' % value
subprocess.check_call(["wget", fetchurl])
targetfile = './dev/source/docs/AP_Periph-Parameters.rst'
os.rename('Parameters.rst', targetfile)
else: # regular versining
if site == key or site is None:
# Remove old param single file
single_param_file = './%s/source/docs/parameters.rst' % key
debug("Erasing " + single_param_file)
remove_if_exists(single_param_file)
# Remove old versioned param files
if 'antennatracker' in key.lower(): # To main the original script approach instead of the build_parameters.py approach. # noqa: E501
old_parameters_mask = (os.getcwd() +
'/%s/source/docs/parameters-%s-' %
("AntennaTracker", "AntennaTracker"))
else:
old_parameters_mask = (os.getcwd() +
'/%s/source/docs/parameters-%s-' %
(key, key.title()))
try:
old_parameters_files = [
f for f in glob.glob(old_parameters_mask + "*.rst")]
for filename in old_parameters_files:
debug("Erasing rst " + filename)
os.remove(filename)
except Exception as e:
error(e)
pass
# Remove old json file
if 'antennatracker' in key.lower(): # To main the original script approach instead of the build_parameters.py approach. # noqa: E501
target_json_file = ('./%s/source/_static/parameters-%s.json' %
("AntennaTracker", "AntennaTracker"))
else:
target_json_file = ('./%s/source/_static/parameters-%s.json' %
(value, key.title()))
debug("Erasing json " + target_json_file)
remove_if_exists(target_json_file)
# Moves the updated JSON file
if 'antennatracker' in key.lower(): # To main the original script approach instead of the build_parameters.py approach. # noqa: E501
vehicle_json_file = os.getcwd() + '/../new_params_mversion/%s/parameters-%s.json' % ("AntennaTracker", "AntennaTracker") # noqa: E501
else:
vehicle_json_file = os.getcwd() + '/../new_params_mversion/%s/parameters-%s.json' % (value, key.title())
new_file = (
key +
"/source/_static/" +
vehicle_json_file[str(vehicle_json_file).rfind("/")+1:])
try:
debug("Moving " + vehicle_json_file)
# os.rename(vehicle_json_file, new_file)
shutil.copy2(vehicle_json_file, new_file)
except Exception as e:
error(e)
pass
# Copy all parameter files to vehicle folder IFF it is new
try:
new_parameters_folder = (os.getcwd() +
'/../new_params_mversion/%s/' % value)
new_parameters_files = [
f for f in glob.glob(new_parameters_folder + "*.rst")
]
except Exception as e:
error(e)
pass
for filename in new_parameters_files:
# Check possible cached version
try:
new_file = (key +
"/source/docs/" +
filename[str(filename).rfind("/")+1:])
if not os.path.isfile(new_file):
debug("Copying %s to %s (target file does not exist)" % (filename, new_file))
shutil.copy2(filename, new_file)
elif os.path.isfile(filename.replace("new_params_mversion", "old_params_mversion")): # The cached file exists? # noqa: E501
# Temporary debug messages to help with cache tasks.
debug("Check cache: %s against %s" % (filename, filename.replace("new_params_mversion", "old_params_mversion"))) # noqa: E501
debug("Check cache with filecmp.cmp: %s" % filecmp.cmp(filename, filename.replace("new_params_mversion", "old_params_mversion"))) # noqa: E501
debug("Check cache with sha256: %s" % is_the_same_file(filename, filename.replace("new_params_mversion", "old_params_mversion"))) # noqa: E501
if ("parameters.rst" in filename) or (not filecmp.cmp(filename, filename.replace("new_params_mversion", "old_params_mversion"))): # It is different? OR is this one the latest. | Latest file must be built everytime in order to enable Sphinx create the correct references across the wiki. # noqa: E501
debug("Overwriting %s to %s" % (filename, new_file))
shutil.copy2(filename, new_file)
else:
debug("It will reuse the last build of " + new_file)
else: # If not cached, copy it anyway.
debug("Copying %s to %s" % (filename, new_file))
shutil.copy2(filename, new_file)
except Exception as e:
error(e)
pass
def create_latest_parameter_redirect(default_param_file, vehicle):
"""
For a given vehicle create a file called parameters.rst that
redirects to the latest parameters file.(Create to maintaim retro
compatibility.)
"""
out_line = "======================\nParameters List (Full)(\n======================\n"
out_line += "\n.. raw:: html\n\n"
out_line += " <script>location.replace(\"" + default_param_file[:-3] + "html" + "\")</script>"
out_line += "\n\n"
filename = vehicle + "/source/docs/parameters.rst"
with open(filename, "w") as text_file:
text_file.write(out_line)
debug("Created html automatic redirection from parameters.html to %shtml" %
default_param_file[:-3])
def cache_parameters_files(site=None):
"""
For each vechile: put new_params_mversion/ content in
old_params_mversion/ folders and .html built files as well.
"""
for key, value in PARAMETER_SITE.items():
if (site == key or site is None) and (key != 'AP_Periph'): # and (key != 'AP_Periph') workaround until create a versioning for AP_Periph in firmware server # noqa: E501
try:
old_parameters_folder = (os.getcwd() +
'/../old_params_mversion/%s/' % value)
old_parameters_files = [
f for f in glob.glob(old_parameters_folder + "*.*")
]
for file in old_parameters_files:
debug("Removing %s" % file)
os.remove(file)
new_parameters_folder = (os.getcwd() +
'/../new_params_mversion/%s/' % value)
new_parameters_files = [
f for f in glob.glob(new_parameters_folder +
"parameters-*.rst")
]
for filename in new_parameters_files:
debug("Copying %s to %s" %
(filename, old_parameters_folder))
shutil.copy2(filename, old_parameters_folder)
built_folder = os.getcwd() + "/" + key + "/build/html/docs/"
built_parameters_files = [
f for f in glob.glob(built_folder + "parameters-*.html")
]
for built in built_parameters_files:
debug("Copying %s to %s" %
(built, old_parameters_folder))
shutil.copy2(built, old_parameters_folder)
except Exception as e:
error(e)
pass
def put_cached_parameters_files_in_sites(site=None):
"""
For each vechile: put built .html files in site folder
"""
for key, value in PARAMETER_SITE.items():
if (site == key or site is None) and (key != 'AP_Periph'): # and (key != 'AP_Periph') workaround until create a versioning for AP_Periph in firmware server # noqa: E501
try:
built_folder = (os.getcwd() +
'/../old_params_mversion/%s/' % value)
built_parameters_files = [
f for f in glob.glob(built_folder + "parameters-*.html")
]
vehicle_folder = os.getcwd() + "/" + key + "/build/html/docs/"
debug("Site %s getting previously built files from %s" %
(site, built_folder))
for built in built_parameters_files:
if ("latest" not in built): # latest parameters files must be built every time
debug("Reusing built %s in %s " %
(built, vehicle_folder))
shutil.copy(built, vehicle_folder)
except Exception as e:
error(e)
pass
def update_frotend_json():
"""
Frontend get posts from Forum server and insert it into JSON
"""
debug('Running script to get last posts from forum server.')
try:
if platform.system() == "Windows":
subprocess.check_call(["python", "./frontend/scripts/get_discourse_posts.py"])
else:
subprocess.check_call(["python3", "./frontend/scripts/get_discourse_posts.py"])
except Exception as e:
error(e)
pass
def copy_static_html_sites(site, destdir):
"""
Copy pure HMTL folder the same way that Sphinx builds it
"""
if (site in ['frontend', None]) and (destdir is not None):
debug('Copying static sites (only frontend so far).')
update_frotend_json()
folder = 'frontend'
try:
site_folder = os.getcwd() + "/" + folder
targetdir = os.path.join(destdir, folder)
shutil.rmtree(targetdir, ignore_errors=True)
shutil.copytree(site_folder, targetdir)
except Exception as e:
error(e)
pass
def check_imports():
'''check key imports work'''
import pkg_resources
# package names to check the versions of. Note that these can be different than the string used to import the package
requires = ["sphinx_rtd_theme>=1.0.0", "sphinxcontrib.youtube>=1.2.0", "sphinx==5.1.1", "docutils==0.16"]
for r in requires:
debug("Checking for %s" % r)
try:
pkg_resources.require(r)
except pkg_resources.ResolutionError as ex:
print(ex)
fatal("Require %s\nPlease run the wiki build setup script \"Sphinxsetup\"" % r)
debug("Imports OK")
def check_ref_directives():
'''check formatting around ref directive that sphinx does not warn about'''
character_before_ref_tag = re.compile(r"[a-zA-Z0-9_:]:ref:")
character_after_ref_tag = re.compile(r"(:ref:`.*?`[_]{0,2}) ([\.,:])")
# don't check "common="" files in vehicle wikis
skipped_files = set()
for wiki in ALL_WIKIS:
skipped_files.update(glob.glob(f'{wiki}/source/docs/common-*.rst'))
wiki_glob = set(glob.glob("**/*.rst", recursive=True))
files_to_check = wiki_glob.difference(skipped_files)
for f in files_to_check:
with open(f, "r", "utf-8") as file:
for i, line in enumerate(file.readlines()):
if character_before_ref_tag.search(line):
error(f"Remove character before ref directive in \"{f}\" on line number {i+1}")
if character_after_ref_tag.search(line):
error(f"Remove character after ref directive in \"{f}\" on line number {i+1}")
def create_features_pages(site):
'''for each vehicle, write out a page containing features for each
supported board'''
debug("Creating features pages")
# grab build_options which allows us to map from define to name
# and description. Create a convenience hash for it
remove_if_exists("build_options.py")
fetch_url("https://raw.githubusercontent.com/ArduPilot/ardupilot/master/Tools/scripts/build_options.py")
import build_options
build_options_by_define = {}
for f in build_options.BUILD_OPTIONS:
build_options_by_define[f.define] = f
# fetch and load most-recently-built features.json
remove_if_exists("features.json.gz")
fetch_url("https://firmware.ardupilot.org/features.json.gz")
features_json = json.load(gzip.open("features.json.gz"))
if features_json["format-version"] != "1.0.0":
print("bad format version")
return
features = features_json["features"]
# print("features: (%s)" % str(features))
for wiki in WIKI_NAME_TO_VEHICLE_NAME.keys():
debug(wiki)
if site is not None and site != wiki:
continue
if wiki not in WIKI_NAME_TO_VEHICLE_NAME:
continue
vehicletype = WIKI_NAME_TO_VEHICLE_NAME[wiki]
content = create_features_page(features, build_options_by_define, vehicletype)
if wiki == "AP_Periph":
destination_filepath = "dev/source/docs/periph-binary-features.rst"
else:
destination_filepath = "%s/source/docs/binary-features.rst" % wiki
with open(destination_filepath, "w") as f:
f.write(content)
def reference_for_board(board):
'''return a string suitable for creating an anchor in RST to make
board's feture table linkable'''
return "FEATURE_%s" % board
def create_features_page(features, build_options_by_define, vehicletype):
features_by_platform = {}
for build in features:
# print("build: (%s)" % str(build))
if build["vehicletype"] != vehicletype:
continue
features_by_platform[build["platform"]] = build["features"]
rows = []
column_headings = ["Category", "Feature", "Included", "Description"]
all_tables = ""
for platform_key in sorted(features_by_platform.keys(), key=lambda x : x.lower()):
rows = []
platform_features = features_by_platform[platform_key]
sorted_platform_features_in = []
sorted_platform_features_not_in = []
features_in = {}
for feature in platform_features:
feature_in = not feature.startswith("!")
if not feature_in:
feature = feature[1:]
features_in[feature] = feature_in
try:
build_options = build_options_by_define[feature]
except KeyError:
# mismatch between build_options.py and features.json
print("feature %s not in build_options.py" % feature)
continue
if feature_in:
some_list = sorted_platform_features_in
else:
some_list = sorted_platform_features_not_in
some_list.append((build_options.category, feature))
sorted_platform_features = (
sorted(sorted_platform_features_not_in, key=lambda x : x[0] + x[1]) +
sorted(sorted_platform_features_in, key=lambda x : x[0] + x[1]))
for (category, feature) in sorted_platform_features:
build_options = build_options_by_define[feature]
row = [category, build_options.label]
if features_in[feature]:
row.append("Yes")
else:
row.append("No")
row.append(build_options.description)
if not features_in[feature]:
# for now, do not include features that are on the
# board, just those that aren't, per Henry's request:
rows.append(row)
if len(rows) == 0:
t = ""
else:
t = rst_table.tablify(rows, headings=column_headings)
underline = "-" * len(platform_key)
all_tables += ('''
.. _%s:
%s
%s
%s
''' % (reference_for_board(platform_key), platform_key, underline, t))
index = ""
for board in sorted(features_by_platform.keys(), key=lambda x : x.lower()):
index += '- :ref:`%s<%s>`\n\n' % (board, reference_for_board(board))
all_features_rows = []
for feature in sorted(build_options_by_define.values(), key=lambda x : (x.category + x.label).lower()):
all_features_rows.append([feature.category, feature.label, feature.description])
all_features = rst_table.tablify(all_features_rows, headings=["Category", "Feature", "Description"])
return '''
.. _binary-features:
=====================================
List of Firmware Limitations by Board
=====================================
**Dynamically generated by update.py. Do not edit.**
%s Omitted features by board type in "latest" builds from build server
Board Index
===========
%s
.. _all-features:
All Features
============
%s
Boards
======
%s
''' % (vehicletype, index, all_features, all_tables)
#######################################################################
if __name__ == "__main__":
if platform.system() == "Windows":
multiprocessing.freeze_support()
# Set up option parsing to get connection string
parser = argparse.ArgumentParser(
description='Copy Common Files as needed, stripping out non-relevant wiki content',
)
parser.add_argument(
'--site',
help="If you just want to copy to one site, you can do this. Otherwise will be copied.",
)
parser.add_argument(
'--clean',
action='store_true',
help="Does a very clean build - resets git to master head (and TBD cleans up any duplicates in the output).",
)
parser.add_argument(
'--cached-parameter-files',
action='store_true',
help="Do not re-download parameter files",
)
parser.add_argument(
'--parallel',
type=int,
help="limit parallel builds, -1 for unlimited",
default=1,
)
parser.add_argument(
'--destdir',
default=None,
help="Destination directory for compiled docs",
)
parser.add_argument(
'--enablebackups',
action='store_true',