← Back to branch summary

~ubuntu-branches/ubuntu/raring/ffc/raring

« back to all changes in this revision

Viewing changes to doc/sphinx/scripts/README_generate_modules.rst

  • Committer: Package Import Robot
  • Author(s): Johannes Ring
  • Date: 2011-11-29 11:38:38 UTC
  • mfrom: (1.1.11)
  • Revision ID: package-import@ubuntu.com-20111129113838-vx815cxjdf50zuq3
Tags: 1.0-rc1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/sphinx/scripts/README_generate_modules.rst
 
1
 
 
2
Generate Modules
 
3
================
 
4
 
 
5
This script parses a directory tree looking for python modules and packages and
 
6
creates ReST files appropriately to create code documentation with Sphinx.
 
7
It also creates a modules index. 
 
8
 
 
9
 
 
10
Usage::
 
11
 
 
12
    Usage: generate_modules.py [options] <package path> [exclude paths, ...]
 
13
        
 
14
    Note: By default this script will not overwrite already created files.
 
15
    
 
16
    Options:
 
17
      -h, --help            show this help message and exit
 
18
      -n HEADER, --doc-header=HEADER
 
19
                            Documentation Header (default=Project)
 
20
      -d DESTDIR, --dest-dir=DESTDIR
 
21
                            Output destination directory
 
22
      -s SUFFIX, --suffix=SUFFIX
 
23
                            module suffix (default=txt)
 
24
      -m MAXDEPTH, --maxdepth=MAXDEPTH
 
25
                            Maximum depth of submodules to show in the TOC
 
26
                            (default=4)
 
27
      -r, --dry-run         Run the script without creating the files
 
28
      -f, --force           Overwrite all the files
 
29
      -t, --no-toc          Don't create the table of content file