summaryrefslogtreecommitdiff
path: root/sphinx/apidoc.py
diff options
context:
space:
mode:
authordc mouser <mouser@donationcoder.com>2013-09-08 16:25:41 -0500
committerdc mouser <mouser@donationcoder.com>2013-09-08 16:25:41 -0500
commit3f888742ff1011e413dfa11d21819e3ae8bdf15d (patch)
tree7079e2bb434a8cc787429e3d40653816ac7a97d7 /sphinx/apidoc.py
parentcc570edf37a8e32d7c3323d59d225cae285570d4 (diff)
downloadsphinx-git-3f888742ff1011e413dfa11d21819e3ae8bdf15d.tar.gz
Added option to apidoc to have it output each module to its own page and updated apidoc docs.
Diffstat (limited to 'sphinx/apidoc.py')
-rw-r--r--sphinx/apidoc.py15
1 files changed, 2 insertions, 13 deletions
diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py
index d622ad313..9948b1cc2 100644
--- a/sphinx/apidoc.py
+++ b/sphinx/apidoc.py
@@ -101,10 +101,7 @@ def create_package_file(root, master_package, subroot, py_files, opts, subs):
else:
heading = ':mod:`%s` Module' % py_file
-
-
- # ATTN: mouser@donationcoder.com - 9/3/13
- # new option to have each module go on its own page
+ # option to have each module go on its own page
if (opts.separatepages):
if (is_package):
# we handle packages SLIGHTLY differently in this case; no need
@@ -134,8 +131,6 @@ def create_package_file(root, master_package, subroot, py_files, opts, subs):
text += format_directive(is_package and subroot or py_path,
master_package)
-
-
text += '\n'
# build a list of directories that are packages (contain an INITPY file)
@@ -304,13 +299,7 @@ Note: By default this script will not overwrite already created files.""")
parser.add_option('-R', '--doc-release', action='store', dest='release',
help='Project release, used when --full is given, '
'defaults to --doc-version')
-
-
-
- # ATTN: mouser@donationcoder.com - 9/3/13
- # Adding option to output each module on its own page rather than combine
- # all modules in a package on one page.
- parser.add_option('-E', '--separate-pages', action='store_true', dest='separatepages',
+ parser.add_option('-E', '--separate', action='store_true', dest='separatepages',
help='Put each module file in its own page, ')