diff options
author | Jenkins <jenkins@review.openstack.org> | 2012-07-10 23:45:55 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2012-07-10 23:45:55 +0000 |
commit | 3580021d438534eb0e52f2ba976f61d6c58f720b (patch) | |
tree | 6ba52f7ddf6a1b5739494622279ec141e7ebe340 /doc | |
parent | dba3622f37eedaea369c13ddd618d37f7516f62a (diff) | |
parent | eb2de037a387a2f20f50a81c973a2efd48d73494 (diff) | |
download | nova-3580021d438534eb0e52f2ba976f61d6c58f720b.tar.gz |
Merge "Update common setup code to latest."
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ext/nova_autodoc.py | 12 | ||||
-rwxr-xr-x | doc/find_autodoc_modules.sh | 20 | ||||
-rwxr-xr-x | doc/generate_autodoc_index.sh | 46 | ||||
-rw-r--r-- | doc/source/conf.py | 5 |
4 files changed, 0 insertions, 83 deletions
diff --git a/doc/ext/nova_autodoc.py b/doc/ext/nova_autodoc.py deleted file mode 100644 index 6c5376fe16..0000000000 --- a/doc/ext/nova_autodoc.py +++ /dev/null @@ -1,12 +0,0 @@ -import gettext -import os - -gettext.install('nova') - -from nova import utils - - -def setup(app): - print "**Autodocumenting from %s" % os.path.abspath(os.curdir) - rv = utils.execute('./doc/generate_autodoc_index.sh') - print rv[0] diff --git a/doc/find_autodoc_modules.sh b/doc/find_autodoc_modules.sh deleted file mode 100755 index 0aff36f7d0..0000000000 --- a/doc/find_autodoc_modules.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/bash - -NOVA_DIR='nova/' # include trailing slash -DOCS_DIR='source' - -modules='' -for x in `find ${NOVA_DIR} -name '*.py' | grep -v nova/tests`; 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 - if [ ! -f "${DOCS_DIR}/${mod}.rst" ]; - then - echo ${mod} - fi -done diff --git a/doc/generate_autodoc_index.sh b/doc/generate_autodoc_index.sh deleted file mode 100755 index bdfa73a496..0000000000 --- a/doc/generate_autodoc_index.sh +++ /dev/null @@ -1,46 +0,0 @@ -#!/bin/sh - -SOURCEDIR=doc/source/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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 8ced294d25..78feba48ef 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,11 +27,6 @@ sys.path.insert(0, os.path.abspath('./')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'ext.nova_todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz'] -# autodoc generation is a bit aggressive and a nuisance when doing heavy text edit cycles. -# execute "export SPHINX_DEBUG=1" in your terminal to disable -if not os.getenv('SPHINX_DEBUG'): - extensions += ['ext.nova_autodoc'] - todo_include_todos = True # Add any paths that contain templates here, relative to this directory. |