freqtrade/tests/test_docs.sh

#!/bin/bash
# Test Documentation boxes -
# !!! <TYPE>: is not allowed!
# !!! <TYPE> "title" - Title needs to be quoted!
# Same for ???
grep -Er '^(!{3}|\?{3})\s\S+:|^(!{3}|\?{3})\s\S+\s[^"]' docs/*
format_issues=$?

failed=0

# Check for the presence of the "!!!" or "???" markers in the files
# the consecutive non-empty line must begin with 4 spaces
while read -r file; do
    awk -v fname="$file" '
    /^(!!!|\?\?\?)/ {
        current_line_number = NR
        current_line = $0
        found_next_content = 0
        while (getline nextLine > 0) {
            # Skip empty lines
            if (nextLine ~ /^$/) {
                continue
            }
            found_next_content = 1
            if (nextLine !~ /^    /) {
                print "File:", fname
                print "Error in Line ", current_line_number, "Expected next non-empty line to start with 4 spaces"
                print ">>", current_line
                print "------"
                exit 1
            }
            break
        }
        if (!found_next_content) {
            print "File:", fname
            print "Error in Line ", current_line_number, "Found marker but no content following it"
            print ">>", current_line
            print "------"
            exit 1
        }
    }
    ' "$file"

    if [ $? -ne 0 ]; then
        failed=1
    fi
done < <(find . -type f -name "*.md")

if  [ $format_issues -eq 1 ] && [ $failed -eq 0 ]; then
    echo "Docs test success."
    exit 0
fi
echo "Docs test failed."
exit 1