summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDoug Hellmann <doug.hellmann@dreamhost.com>2012-03-05 14:33:40 -0500
committerDoug Hellmann <doug.hellmann@dreamhost.com>2012-03-05 16:18:53 -0500
commitb1de27f68a9f80db723c1b3545f95c5c9c8e7e9d (patch)
tree13476ca8ca0cc0ed9667dfe9b0cc33fed61fc4b0 /doc
parent5f9cee0c9c95b61d548730e7918e5c623301b3b1 (diff)
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
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/generate_autodoc_index.sh3
-rw-r--r--doc/source/conf.py2
2 files changed, 3 insertions, 2 deletions
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.