diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-09-02 20:46:25 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-09-06 18:29:44 +0900 |
| commit | 86abb5757761ffb1122ab03e7b81cc09e863a9ea (patch) | |
| tree | 4fef0e7344038b893e5cea9e8c7e5c951e3101c1 /sphinx/ext/apidoc.py | |
| parent | 4abc55239a5ecd52c249bf0ede0fea44504b1fc8 (diff) | |
| download | sphinx-git-86abb5757761ffb1122ab03e7b81cc09e863a9ea.tar.gz | |
Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToC
Diffstat (limited to 'sphinx/ext/apidoc.py')
| -rw-r--r-- | sphinx/ext/apidoc.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index 8a7c68402..a154f6449 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -340,7 +340,9 @@ Note: By default this script will not overwrite already created files.""")) parser.add_argument('-P', '--private', action='store_true', dest='includeprivate', help=__('include "_private" modules')) - parser.add_argument('-T', '--no-toc', action='store_true', dest='notoc', + parser.add_argument('--tocfile', action='store', dest='tocfile', default='modules', + help=__("don't create a table of contents file")) + parser.add_argument('-T', '--no-toc', action='store_false', dest='tocfile', help=__("don't create a table of contents file")) parser.add_argument('-E', '--no-headings', action='store_true', dest='noheadings', @@ -453,8 +455,8 @@ def main(argv=sys.argv[1:]): if not args.dryrun: qs.generate(d, silent=True, overwrite=args.force) - elif not args.notoc: - create_modules_toc_file(modules, args) + elif args.tocfile: + create_modules_toc_file(modules, args, args.tocfile) return 0 |