Check documentation for unused includes.
This commit is contained in:
+1
-1
@@ -7,5 +7,5 @@ cd $SPHINX
|
||||
|
||||
sphinx-build -a source ../doc || exit 1
|
||||
|
||||
echo Not uploading.
|
||||
python checks.py
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
from __future__ import print_function
|
||||
|
||||
import os
|
||||
import re
|
||||
|
||||
def check_include():
|
||||
|
||||
used = set()
|
||||
|
||||
def scan_file(fn):
|
||||
f = open(fn)
|
||||
|
||||
for l in f:
|
||||
m = re.search(r"\.\. include::(.+)", l)
|
||||
|
||||
if not m:
|
||||
continue
|
||||
|
||||
fn = m.group(1).strip()
|
||||
|
||||
used.add(fn)
|
||||
|
||||
for i in os.listdir("source"):
|
||||
if i.endswith(".rst"):
|
||||
scan_file(os.path.join("source", i))
|
||||
|
||||
for i in os.listdir("source/inc"):
|
||||
scan_file(os.path.join("source", "inc", i))
|
||||
|
||||
for i in os.listdir("source/inc"):
|
||||
fn = "inc/" + i
|
||||
if fn not in used:
|
||||
print("WARNING: source/{} is not used.".format(fn))
|
||||
|
||||
if __name__ == "__main__":
|
||||
check_include()
|
||||
Reference in New Issue
Block a user