.\" Process this file with .\" groff -man -Tascii supybot-plugin-doc.1 .\" .TH SUPYBOT-PLUGIN-DOC 1 "May 2009" .SH NAME supybot-plugin-doc \- Generates the documentation for a Supybot plugin .SH SYNOPSIS .B supybot-plugin-doc .RI [ options ] .SH DESCRIPTION .B supybot-plugin-doc is used to generate documentation (StructuredText or reStructuredText format) for a .IR supybot (1) plugin. .SH OPTIONS .TP .B \-\^\-version Show version of program. .TP .BR \-h ", " \-\^\-help Show summary of options. .TP .BR \-c ", " \-\^\-clean Clean the various data/conf/log directories after generating the docs. .TP .BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR Specifies the directory in which to write the documentation for the plugin. .TP .BR \-f ", " \-\^\-format= \fIFORMAT Specifies which output format to use. Choices are 'rst' or 'stx'. .TP .BI \-\^\-plugins\-dir= PLUGINSDIRS Looks in the given directory for plugins and generates documentation for all of them. .SH "SEE ALSO" .IR python (1), .IR supybot (1), .IR supybot-test (1), .IR supybot-botchk (1), .IR supybot-wizard (1), .IR supybot-adduser (1), .IR supybot-plugin-create (1) .SH AUTHOR This manual page was originally written by James Vega <jamessan at supybot dot com>. Permission is granted to copy, distribute and/or modify this document under the terms of the Supybot license, a BSD-style license.