DOQ(1)

NAME
doq - Docstring generator.

SYNOPSIS
doq [-h] [--print-completion {bash,zsh,tcsh}] [-f FILE] [--start START]
    [--end END] [-t TEMPLATE_PATH] [-s STYLE] [--formatter FORMATTER]
    [--indent INDENT] [--omit OMIT] [-r] [-d DIRECTORY] [-w] [-v]
    [-c CONFIG] [--ignore_exception] [--ignore_yield] [--ignore_init]

DESCRIPTION
Docstring generator.

OPTIONS

-h, --help
    show this help message and exit

--print-completion {bash,zsh,tcsh}
    print shell completion script

-f FILE, --file FILE
    File or STDIN

--start START
    Start lineno

--end END
    End lineno

-t TEMPLATE_PATH, --template_path TEMPLATE_PATH
    Path to template directory

-s STYLE, --style STYLE
    Output style string or json

--formatter FORMATTER
    Docstring formatter. sphinx,google or numpy

--indent INDENT
    Indent number

--omit OMIT
    Omit first argument such as self

-r, --recursive
    Run recursively over directories

-d DIRECTORY, --directory DIRECTORY
    Path to directory

-w, --write
    Edit files in-place

-v, --version
    Output the version number

-c CONFIG, --config CONFIG
    Path to a setup.cfg or pyproject.toml

--ignore_exception
    Ignore exception statements

--ignore_yield
    Ignore yield statements

--ignore_init
    Ignore generate docstring to __init__ method