clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-06-30 01:35:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

added documentation comments to parse-link-check.py

Browse Source
This commit is contained in:
Kevin Putnam
2018-12-18 11:56:15 -08:00
parent 44978b744d
commit 4a3b374367
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/scripts/_python/parse-link-check.py
+20
View File
@@ -1,5 +1,25 @@
#!/usr/bin/env python
#***********************************************************
#
# parse-link-check.py
#
# Arguments:
# 1. path to input file
#
# External file dependencies:
# 1. output.txt - the output of sphinx-build
# 2. link-whitelist.txt - broken links that should be ignored
#
# Output:
# 1. broken_links.html - provides count of broken and whitelist
# matches. Also provides links to all flagged links. Will
# appear in the same directory as output.txt
# 2. Error code 255 if unexpected broken links are found
#
#***********************************************************
import sys
import re
import os