def validate_documentation_dir()

in tools/validator.py [0:0]

• 14 lines of code
• 2 McCabe index (conditional complexity)

def validate_documentation_dir(validation_config: ValidationConfig,
                               root_dir: str,
                               relative_docs_path: str = DOCS_PATH) -> None:
  """Validate Markdown files in `root_dir/relative_docs_path`.

  Args:
    validation_config: TestConfig specifying whether the "asset-path" tag should
      be validated.
    root_dir: Absolute path to the top-level dir that contains Markdown files
      and YAML config files.
    relative_docs_path: Relative path under `root_dir` containing the Markdown
      files. Defaults to "assets/docs".

  Raises:
    MarkdownDocumentationError: if invalid Markdown files have been found.
  """
  documentation_dir = os.path.join(root_dir, relative_docs_path)
  logging.info("Validating all files in %s.", documentation_dir)
  relative_paths = [
      os.path.relpath(file_path, documentation_dir)
      for file_path in filesystem_utils.recursive_list_dir(documentation_dir)
  ]
  validate_documentation_files(
      validation_config,
      root_dir,
      relative_paths,
      relative_docs_path=relative_docs_path)