1SUPYBOT-PLUGIN-DOC(1)       General Commands Manual      SUPYBOT-PLUGIN-DOC(1)
2
3
4

NAME

6       supybot-plugin-doc - Generates the documentation for a Supybot plugin
7

SYNOPSIS

9       supybot-plugin-doc [options]
10

DESCRIPTION

12       supybot-plugin-doc is used to generate documentation (StructuredText or
13       reStructuredText format) for a supybot(1) plugin.
14

OPTIONS

16       --version
17              Show version of program.
18
19       -h, --help
20              Show summary of options.
21
22       -c, --clean
23              Clean the various data/conf/log directories after generating the
24              docs.
25
26       -o, --output-dir=OUTPUTDIR
27              Specifies  the directory in which to write the documentation for
28              the plugin.
29
30       -f, --format=FORMAT
31              Specifies which output format to  use.   Choices  are  'rst'  or
32              'stx'.
33
34       --plugins-dir=PLUGINSDIRS
35              Looks  in the given directory for plugins and generates documen‐
36              tation for all of them.
37

SEE ALSO

39       python(1), supybot(1), supybot-test(1), supybot-botchk(1), supybot-wiz‐
40       ard(1), supybot-adduser(1), supybot-plugin-create(1)
41

AUTHOR

43       This  manual  page  was  originally  written by James Vega <jamessan at
44       supybot dot com>.  Permission is granted  to  copy,  distribute  and/or
45       modify  this  document  under  the terms of the Supybot license, a BSD-
46       style license.
47
48
49
50                                   May 2009              SUPYBOT-PLUGIN-DOC(1)