diff options
| author | Jenkins <jenkins@review.openstack.org> | 2012-03-01 22:38:41 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2012-03-01 22:38:41 +0000 |
| commit | d65a4e4023e9994c8a14a1da4aa4eeb4f6452640 (patch) | |
| tree | 7c107b2a2896c041176d6b8b132f93c0de967eeb | |
| parent | 07ca6f64de76b5955c233b830122877dc07df142 (diff) | |
| parent | 1ea445c377d25970cb73f5f35004e02c5e066ca4 (diff) | |
| download | nova-d65a4e4023e9994c8a14a1da4aa4eeb4f6452640.tar.gz nova-d65a4e4023e9994c8a14a1da4aa4eeb4f6452640.tar.xz nova-d65a4e4023e9994c8a14a1da4aa4eeb4f6452640.zip | |
Merge "blueprint sphinx-doc-cleanup bug 944381"
| -rw-r--r-- | Authors | 1 | ||||
| -rw-r--r-- | doc/ext/nova_autodoc.py | 1 | ||||
| -rwxr-xr-x | doc/generate_autodoc_index.sh | 11 |
3 files changed, 11 insertions, 2 deletions
@@ -51,6 +51,7 @@ Devendra Modium <dmodium@isi.edu> Devin Carlen <devin.carlen@gmail.com> Donal Lafferty <donal.lafferty@citrix.com> Dong-In David Kang <dkang@isi.edu> +Doug Hellmann <doug.hellmann@dreamhost.com> Duncan McGreggor <duncan@dreamhost.com> Ed Leafe <ed@leafe.com> Edouard Thuleau <edouard1.thuleau@orange.com> diff --git a/doc/ext/nova_autodoc.py b/doc/ext/nova_autodoc.py index 3dd992d84..704c590f0 100644 --- a/doc/ext/nova_autodoc.py +++ b/doc/ext/nova_autodoc.py @@ -5,6 +5,7 @@ gettext.install('nova') from nova import utils + def setup(app): rootdir = os.path.abspath(app.srcdir + '/..') print "**Autodocumenting from %s" % rootdir diff --git a/doc/generate_autodoc_index.sh b/doc/generate_autodoc_index.sh index 4e2870bfc..5d9cdd315 100755 --- a/doc/generate_autodoc_index.sh +++ b/doc/generate_autodoc_index.sh @@ -10,9 +10,16 @@ for x in `./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. + let heading_len=$(echo "$heading" | wc -c) + underline=$(head -c $heading_len < /dev/zero | tr '\0' '=') ( cat <<EOF -The :mod:\`${x}\` Module -============================================================================== +${heading} +${underline} .. automodule:: ${x} :members: :undoc-members: |