zecfoundation
/
cloud-foundation-fabric
mirror of https://github.com/ZcashFoundation/cloud-foundation-fabric.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #465 from GoogleCloudPlatform/ludo/check-docs-exclude 

Support exclude in check docs
This commit is contained in:
Julio Castillo 2022-01-27 17:42:05 +01:00 committed by GitHub
parent 0867d6f6e2 cb9340fd4f
commit bd9fb3208b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
tools/check_documentation.py
View File

@ -36,7 +36,7 @@ BASEDIR = pathlib.Path(__file__).resolve().parents[1]
State = enum.Enum('State', 'OK FAIL SKIP')
def _check_dir(dir_name, files=False, show_extra=False):
def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False):
'Invoke tfdoc on folder, using the relevant options.'
dir_path = BASEDIR / dir_name
for readme_path in sorted(dir_path.glob('**/README.md')):
@ -50,9 +50,8 @@ def _check_dir(dir_name, files=False, show_extra=False):
state = State.SKIP
else:
try:
new_doc = tfdoc.create_doc(readme_path.parent, files=files,
show_extra=show_extra, exclude_files=None,
readme=readme)
new_doc = tfdoc.create_doc(readme_path.parent, files, show_extra,
exclude_files, readme)
except SystemExit:
state = state.SKIP
else:
@ -70,17 +69,20 @@ def _check_dir(dir_name, files=False, show_extra=False):
@click.command()
@click.argument('dirs', type=str, nargs=-1)
@ click.option('--files/--no-files', default=False)
@ click.option('--show-diffs/--no-show-diffs', default=False)
@ click.option('--show-extra/--no-show-extra', default=False)
def main(dirs, files=False, show_diffs=False, show_extra=False):
@click.option('--exclude-file', '-x', multiple=True)
@click.option('--files/--no-files', default=False)
@click.option('--show-diffs/--no-show-diffs', default=False)
@click.option('--show-extra/--no-show-extra', default=False)
def main(dirs, exclude_file=None, files=False, show_diffs=False,
show_extra=False):
'Cycle through modules and ensure READMEs are up-to-date.'
print(f'files: {files}, extra: {show_extra}, diffs: {show_diffs}\n')
errors = []
state_labels = {State.FAIL: '✗', State.OK: '✓', State.SKIP: '?'}
for dir_name in dirs:
print(f'----- {dir_name} -----')
for mod_name, state, diff in _check_dir(dir_name, files, show_extra):
for mod_name, state, diff in _check_dir(dir_name, exclude_file, files,
show_extra):
if state == State.FAIL:
errors.append(diff)
print(f'[{state_labels[state]}] {mod_name}')

10
tools/tfdoc.py
View File

@ -399,12 +399,12 @@ def replace_doc(readme_path, doc, readme=None):
raise SystemExit(f'Error replacing README {readme_path}: {e}')
@ click.command()
@ click.argument('module_path', type=click.Path(exists=True))
@click.command()
@click.argument('module_path', type=click.Path(exists=True))
@click.option('--exclude-file', '-x', multiple=True)
@ click.option('--files/--no-files', default=False)
@ click.option('--replace/--no-replace', default=True)
@ click.option('--show-extra/--no-show-extra', default=False)
@click.option('--files/--no-files', default=False)
@click.option('--replace/--no-replace', default=True)
@click.option('--show-extra/--no-show-extra', default=False)
def main(module_path=None, exclude_file=None, files=False, replace=True,
show_extra=True):
'Program entry point.'