Skip to content

[ur] Actually fail when RST validation finds an error #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kbenzie merged 1 commit into from
Jun 7, 2023
Merged

[ur] Actually fail when RST validation finds an error #580

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions scripts/generate_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ def _make_ref(symbol, symbol_type, meta):
ref = ":ref:`" + ref + " <" + target.replace("_", "-") + ">`"
else:
print("%s(%s) : error : enum symbol not found for etor %s"%(fin, iline+1, symbol))
raise Exception()
elif not re.match("function", symbol_type):
ref = ":ref:`" + ref.replace("_", "-") + "`"
else:
Expand All @@ -92,6 +93,8 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):

print("Generating %s..."%fout)

error = False

outlines = []
for iline, line in enumerate(util.textRead(fin)):

Expand All @@ -116,6 +119,7 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):

if re.match(RE_INVALID_TAG_FORMAT, line):
print("%s(%s) : error : invalid %s tag used"%(fin, iline+1, re.sub(RE_INVALID_TAG_FORMAT, r"\1", line)))
error = True

newline = line # new line will contain proper tags for reStructuredText if needed.
if re.match(RE_PROPER_TAG_FORMAT, line):
Expand All @@ -128,6 +132,7 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):
symbol_type = _find_symbol_type(symbol, meta)
if not symbol_type:
print("%s(%s) : error : symbol '%s' not found"%(fin, iline+1, symbol))
error = True
continue

if code_block and 'function' == symbol_type:
Expand All @@ -136,6 +141,7 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):
if len(words) != len(meta['function'][symbol]['params']):
print("%s(%s) : error : %s parameter count mismatch - %s actual vs. %s expected"%(fin, iline+1, symbol, len(words), len(meta['function'][symbol]['params'])))
print("line = %s"%line)
error = True

ref = _make_ref(symbol, symbol_type, meta)
if ref:
Expand All @@ -157,6 +163,9 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):

outlines.append(newline)

if error:
raise Exception('Error during reStructuredText generation.')

util.writelines(os.path.abspath(fout), outlines)

return util.makoWrite(os.path.abspath(fout), fout,
Expand Down