From 1106d7622e9327d4db417ae8bc7a18bb5d64fa1c Mon Sep 17 00:00:00 2001
From: Todd Willey <todd@ansolabs.com>
Date: Thu, 28 Oct 2010 18:59:03 -0400
Subject: A shell script for showing modules that aren't documented in .rst
 files.

---
 doc/find_undocumented_classes.sh | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100755 doc/find_undocumented_classes.sh

(limited to 'doc')

diff --git a/doc/find_undocumented_classes.sh b/doc/find_undocumented_classes.sh
new file mode 100755
index 000000000..845e0b5e0
--- /dev/null
+++ b/doc/find_undocumented_classes.sh
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+NOVA_DIR='../nova/' # include trailing slash
+DOCS_DIR='source'
+
+modules=''
+for x in `find ${NOVA_DIR} -name '*.py'`; do
+    if [ `basename ${x} .py` == "__init__" ] ; then
+        continue
+    fi
+    relative=nova.`echo ${x} | sed -e 's$^'${NOVA_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'`
+    modules="${modules} ${relative}"
+done
+
+for mod in ${modules} ; do
+    op=`grep ${mod} ${DOCS_DIR}/*.rst`
+    if [ -z "${op}" ] ; then
+        echo ${mod}
+    fi
+done
-- 
cgit