1423480fb6
The following spec defines what each project's doc/source directory is supposed to look like: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html I had not yet moved existing content to follow this design. This patch does that, moving the devref to the 'contributor' directory. It also moves the CLI related documentation into the 'cli' directory. I have updated the autodoc generation to now create the api documentation in 'doc/source/contributor/api'. This patch also creates a template for future documentation contribution. I have created all of the directories recommended by the spec and have included documentation as to what should go in each directory. The index file is updated to point at the new locations for existing content. 'doc/.gitignore' is updated so that it won't complain about the automatically generated 'doc/contributor/api' directory. Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
47 lines
1.0 KiB
Bash
Executable File
47 lines
1.0 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
SOURCEDIR=doc/source/contributor/api
|
|
|
|
if [ ! -d ${SOURCEDIR} ] ; then
|
|
mkdir -p ${SOURCEDIR}
|
|
fi
|
|
|
|
for x in `./doc/find_autodoc_modules.sh`;
|
|
do
|
|
echo "Generating ${SOURCEDIR}/${x}.rst"
|
|
echo "${SOURCEDIR}/${x}.rst" >> .autogenerated
|
|
heading="The :mod:\`${x}\` Module"
|
|
# Figure out how long the heading is
|
|
# and make sure to emit that many '=' under
|
|
# it to avoid heading format errors
|
|
# in Sphinx.
|
|
heading_len=$(echo "$heading" | wc -c)
|
|
underline=$(head -c $heading_len < /dev/zero | tr '\0' '=')
|
|
( cat <<EOF
|
|
${heading}
|
|
${underline}
|
|
|
|
.. automodule:: ${x}
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
EOF
|
|
) > ${SOURCEDIR}/${x}.rst
|
|
|
|
done
|
|
|
|
if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then
|
|
|
|
cat > ${SOURCEDIR}/autoindex.rst <<EOF
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
EOF
|
|
for f in `cat .autogenerated | sort` ; do
|
|
relative=`echo ${f} | sed -e 's$^'${SOURCEDIR}'/$$'`
|
|
echo " ${relative}" >> ${SOURCEDIR}/autoindex.rst
|
|
done
|
|
|
|
echo ${SOURCEDIR}/autoindex.rst >> .autogenerated
|
|
fi
|