From b1de27f68a9f80db723c1b3545f95c5c9c8e7e9d Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug.hellmann@dreamhost.com>
Date: Mon, 5 Mar 2012 14:33:40 -0500
Subject: fix restructuredtext formatting in docstrings that show up in the
 developer guide

blueprint sphinx-doc-cleanup
bug 945160

- Correct parameter declarations, list formatting, cross-references, etc.
- We don't need "let" in generate_autodoc_index.sh since we aren't doing math.
- Change conf.py to not prefix class and function names with full namespace
  in generated output to save width on the screen.

Change-Id: I9adc8681951913fd291d03e7142146e9d46841df
---
 doc/generate_autodoc_index.sh | 3 ++-
 doc/source/conf.py            | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/generate_autodoc_index.sh b/doc/generate_autodoc_index.sh
index 5d9cdd315..4e0bc2a8b 100755
--- a/doc/generate_autodoc_index.sh
+++ b/doc/generate_autodoc_index.sh
@@ -15,11 +15,12 @@ do
   # and make sure to emit that many '=' under
   # it to avoid heading format errors
   # in Sphinx.
-  let heading_len=$(echo "$heading" | wc -c)
+  heading_len=$(echo "$heading" | wc -c)
   underline=$(head -c $heading_len < /dev/zero | tr '\0' '=')
   ( cat <<EOF
 ${heading}
 ${underline}
+
 .. automodule:: ${x}
   :members:
   :undoc-members:
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 99baf9e78..6e4c53d68 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -92,7 +92,7 @@ exclude_trees = []
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+add_module_names = False
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-- 
cgit