Added option to apidoc to have it output each module to its own page and updated apidoc docs.

This commit is contained in:
dc mouser 2013-09-08 16:25:41 -05:00
parent cc570edf37
commit 3f888742ff
2 changed files with 3 additions and 13 deletions

View File

@ -33,6 +33,7 @@ Options
-T, --no-toc Do not create a table of contents file.
-F, --full If given, a full Sphinx project is generated (``conf.py``,
``Makefile`` etc.) using sphinx-quickstart.
-E, --separate Put each module file in its own page.
These options are used with ``-F``:

View File

@ -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, ')