forked from 2600hz/kazoo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validate_mkdocs.py
executable file
·46 lines (38 loc) · 1.3 KB
/
validate_mkdocs.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
#!/usr/bin/env python2
from __future__ import print_function
import yaml, os.path, sys
# from https://stackoverflow.com/questions/5574702/how-to-print-to-stderr-in-python
def eprint(*args, **kwargs):
print(*args, file=sys.stderr, **kwargs)
def parse_page_dict(errors_detected, kv):
(header, pages) = kv
if pages is None:
eprint("section ", header, " is incomplete")
return True
else:
return parse_page(errors_detected, pages)
def parse_page_string(errors_detected, page):
if "index.md" != page and (not os.path.isfile(page)):
eprint("page ", page, " is not valid")
return True
else:
return errors_detected
def parse_page(errors_detected, page):
"parse a page for existence"
if isinstance(page, dict):
return reduce(parse_page_dict, page.items(), errors_detected)
elif isinstance(page, list):
return reduce(parse_page, page, errors_detected)
elif isinstance(page, str):
return parse_page_string(errors_detected, page)
else:
return errors_detected
stream = open("doc/mkdocs/mkdocs.yml", 'r')
mkdocs = yaml.load_all(stream)
errors_detected = False
for doc in mkdocs:
for k,v in doc.items():
if "pages" == k:
errors_detected = parse_page(False, v)
if errors_detected:
sys.exit(1)