A shell script for showing modules that aren't documented in .rst files.
This commit is contained in:
20
doc/find_undocumented_classes.sh
Executable file
20
doc/find_undocumented_classes.sh
Executable file
@@ -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
|
||||
Reference in New Issue
Block a user