99d49dd358
This fix adds the detailed API reference to the developers guide as it's done in major projects in the stack. It also fix Sphinx warning and errors and adds a .rst files generator to easily update the api reference in the future. Plus, it includes an index for API, modules and search. Co-Authored-By: Flavio Percoco <fpercoco@redhat.com> Change-Id: If42121c9e8e852785cb2db3aa5d6895223b9d604
20 lines
490 B
Bash
Executable File
20 lines
490 B
Bash
Executable File
#!/bin/bash
|
|
|
|
ZAQAR_DIR='../../zaqar/' # include trailing slash
|
|
DOCS_DIR='source'
|
|
|
|
modules=''
|
|
for x in `find ${ZAQAR_DIR} -name '*.py' | grep -v zaqar/tests | grep -v zaqar/bench`; do
|
|
if [ `basename ${x} .py` == "__init__" ] ; then
|
|
continue
|
|
fi
|
|
relative=zaqar.`echo ${x} | sed -e 's$^'${ZAQAR_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'`
|
|
modules="${modules} ${relative}"
|
|
done
|
|
|
|
for mod in ${modules} ; do
|
|
if [ ! -f "${DOCS_DIR}/${mod}.rst" ];
|
|
then
|
|
echo ${mod}
|
|
fi
|
|
done |