doc-warden

# Assume you have cloned a repository that needs documentation checks # and that a .docsettings.yml file is present at its root. # For example, let's use a placeholder for $(Build.SourcesDirectory) REPO_ROOT="/path/to/your/repo" # Install Doc-Warden (if not already installed) # pip install doc-warden # Example 1: Scan for Readme and Changelog standards (default .docsettings.yml at root) print(f"Running doc-warden scan on {REPO_ROOT}...") # In a real CI environment, this would be executed directly # import subprocess # subprocess.run(['ward', 'scan', '-d', REPO_ROOT], check=True) print("ward scan -d $REPO_ROOT") # Example 2: Scan with a custom .docsettings.yml path DOCSETTINGS_PATH="$REPO_ROOT/eng/.docsettings.yml" print(f"Running doc-warden scan on {REPO_ROOT} with custom config {DOCSETTINGS_PATH}...") # subprocess.run(['ward', 'scan', '-d', REPO_ROOT, '-c', DOCSETTINGS_PATH], check=True) print(f"ward scan -d $REPO_ROOT -c {DOCSETTINGS_PATH}")