etienned/sphinx-autopackage-script

sphinx-autopackage-script

Clone Fork Compare
New file

sphinx-autopackage-script /

Filename Size Date modified Message
1.1 KB
README: fix grammar
9.7 KB
use absolute path for root (thanks to Jan Marten Simons for the patch)

Generate Modules

This script parses a directory tree looking for python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index.

Usage:

Usage: generate_modules.py [options] <package path> [exclude paths, ...]

Note: By default this script will not overwrite already created files.

Options:
  -h, --help            show this help message and exit
  -n HEADER, --doc-header=HEADER
                        Documentation Header (default=Project)
  -d DESTDIR, --dest-dir=DESTDIR
                        Output destination directory
  -s SUFFIX, --suffix=SUFFIX
                        module suffix (default=txt)
  -m MAXDEPTH, --maxdepth=MAXDEPTH
                        Maximum depth of submodules to show in the TOC
                        (default=4)
  -r, --dry-run         Run the script without creating the files
  -f, --force           Overwrite all the files
  -t, --no-toc          Don't create the table of content file
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.