OpenUT99-Plus
Unreal Engine 1, rebuilt from scratch
Loading...
Searching...
No Matches
check_docs Namespace Reference

Functions

 _files (root)
 check (root)

Variables

dict SKIP_DIRS = {".git", "__pycache__", "out", "build", "superpowers", ".superpowers"}
dict SELF_TESTS = {"test_check_docs.py"}
 LINK = re.compile(r"\[[^\‍]]*\‍]\‍(([^)\s]+)\‍)")
 TICK = re.compile(r"`([^`\s]+)`")
list PERSONAL
 found = check(sys.argv[1] if len(sys.argv) > 1 else os.path.join(os.path.dirname(__file__), ".."))

Detailed Description

Documentation checker. Usage: check_docs.py [repo_root]  (exit 1 on problems)

Flags: broken relative links in .md, repo paths in backticks that do not exist,
personal data (drive paths, user home dirs, WSL mounts, IPv4, private keys) in .md/.py/.cpp/.h/.txt,
PROJECT_MEMORY stages with more than 3 bullets.

Function Documentation

◆ _files()

check_docs._files ( root)
protected

◆ check()

check_docs.check ( root)

Variable Documentation

◆ found

check_docs.found = check(sys.argv[1] if len(sys.argv) > 1 else os.path.join(os.path.dirname(__file__), ".."))

◆ LINK

check_docs.LINK = re.compile(r"\[[^\‍]]*\‍]\‍(([^)\s]+)\‍)")

◆ PERSONAL

list check_docs.PERSONAL
Initial value:
1= [
2 (re.compile(r"\b[A-Za-z]:\\"), "drive path"),
3 (re.compile(r"/(home|mnt)/\w"), "home/mnt path"),
4 (re.compile(r"\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b"), "IP address"),
5 (re.compile(r"-----BEGIN [A-Z ]*KEY"), "private key"),
6]

◆ SELF_TESTS

dict check_docs.SELF_TESTS = {"test_check_docs.py"}

◆ SKIP_DIRS

dict check_docs.SKIP_DIRS = {".git", "__pycache__", "out", "build", "superpowers", ".superpowers"}

◆ TICK

check_docs.TICK = re.compile(r"`([^`\s]+)`")