ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-26 12:21:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

adds stub API docs in a single file (#46663)

Browse source 
* adds stub API docs in a single file
This commit is contained in:
Alicia Cozine 2018-10-11 09:15:24 -05:00 • committed by Sandra McCann
parent e1cfc2500c
commit 9764f32513
11 changed files with 118 additions and 612 deletions
Download patch file Download diff file Expand all files Collapse all files

18
test/sanity/code-smell/docs-build.py
View file

@ -52,12 +52,6 @@ def main():
'unknown-interpreted-text-role': '^Unknown interpreted text role "[^"]*".$',
}
ignore_codes = [
'reference-target-not-found',
]
used_ignore_codes = set()
for line in lines:
match = re.search('^(?P<path>[^:]+):((?P<line>[0-9]+):)?((?P<column>[0-9]+):)? (?P<level>WARNING|ERROR): (?P<message>.*)$', line)
@ -96,20 +90,8 @@ def main():
else:
code = 'error'
if code == 'not-in-toc-tree' and path.startswith('docs/docsite/rst/modules/'):
continue # modules are not expected to be in the toc tree
if code in ignore_codes:
used_ignore_codes.add(code)
continue # ignore these codes
print('%s:%d:%d: %s: %s' % (path, lineno, column, code, message))
unused_ignore_codes = set(ignore_codes) - used_ignore_codes
for code in unused_ignore_codes:
print('test/sanity/code-smell/docs-build.py:0:0: remove `%s` from the `ignore_codes` list as it is no longer needed' % code)
def simplify_stdout(value):
"""Simplify output by omitting earlier 'rendering: ...' messages."""