.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH STUBGEN "1" "February 2019" "stubgen 0.670" "User Commands"
.SH NAME
stubgen \- Generate draft stubs for Python modules.
.SH DESCRIPTION
usage: stubgen [\-h] [\-\-py2] [more options, see \fB\-h]\fR
.IP
[\-m MODULE] [\-p PACKAGE] [files ...]
.PP
Generate draft stubs for modules. Stubs are generated in directory ./out, to
avoid overriding files with manual changes. This directory is assumed to
exist.
.SS "positional arguments:"
.TP
files
generate stubs for given files or directories
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-py2\fR
run in Python 2 mode (default: Python 3 mode)
.TP
\fB\-\-ignore\-errors\fR
ignore errors when trying to generate stubs for
modules
.TP
\fB\-\-no\-import\fR
don't import the modules, just parse and analyze them
(doesn't work with C extension modules and might not
respect __all__)
.TP
\fB\-\-parse\-only\fR
don't perform semantic analysis of sources, just parse
them (only applies to Python modules, might affect
quality of stubs)
.TP
\fB\-\-include\-private\fR
generate stubs for objects and members considered
private (single leading underscore and no trailing
underscores)
.TP
\fB\-\-doc\-dir\fR PATH
use .rst documentation in PATH (this may result in
better stubs in some cases; consider setting this to
DIR/Python\-X.Y.Z/Doc/library)
.TP
\fB\-\-search\-path\fR PATH
specify module search directories, separated by ':'
(currently only used if \fB\-\-no\-import\fR is given)
.TP
\fB\-\-python\-executable\fR PATH
use Python interpreter at PATH (only works for Python
2 right now)
.TP
\fB\-o\fR PATH, \fB\-\-output\fR PATH
change the output directory [default: out]
.TP
\fB\-m\fR MODULE, \fB\-\-module\fR MODULE
generate stub for module; can repeat for more modules
.TP
\fB\-p\fR PACKAGE, \fB\-\-package\fR PACKAGE
generate stubs for package recursively; can be
repeated