---
name: "supybot-plugin-doc"
section: "1"
platform: "linux"
package: "limnoria"
version: "2025.5.3-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/supybot-plugin-doc"
---

# supybot-plugin-doc(1)

Generates the documentation for a Limnoria plugin

## NAME

limnoria-plugin-doc - Generates the documentation for a Limnoria plugin

## SYNOPSIS

**limnoria-plugin-doc** \[*options*\]

## DESCRIPTION

**limnoria-plugin-doc** is used to generate documentation (StructuredText or reStructuredText format) for a [*limnoria*(1)](/limnoria/1.md) plugin.

## OPTIONS

- **--version**

  Show version of program.

- **-h**, **--help**

  Show summary of options.

- **-c**, **--clean**

  Clean the various data/conf/log directories after generating the docs.

- **-o**, **--output-dir=***OUTPUTDIR*

  Specifies the directory in which to write the documentation for the plugin.

- **-f**, **--format=***FORMAT*

  Specifies which output format to use.  Choices are 'rst' or 'stx'.

- **--plugins-dir=***PLUGINSDIRS*

  Looks in the given directory for plugins and generates documentation for all of them.

## SEE ALSO

[*python*(1)](/python/1.md), [*limnoria*(1)](/limnoria/1.md), [*limnoria-test*(1)](/limnoria-test/1.md), [*limnoria-botchk*(1)](/limnoria-botchk/1.md), [*limnoria-wizard*(1)](/limnoria-wizard/1.md), [*limnoria-adduser*(1)](/limnoria-adduser/1.md), [*limnoria-plugin-create*(1)](/limnoria-plugin-create/1.md)

## AUTHOR

This manual page was originally written by James McCoy \<vega dot james at gmail dot com\>.  Permission is granted to copy, distribute and/or modify this document under the terms of the Limnoria license, a BSD-style license.