mirror of https://github.com/Mikaela/Limnoria.git synced 2024-10-01 17:16:31 +02:00

Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs

Starting with this commit, there should be no "original" text
in READMEs.
Instead, the entire text should be in docstrings, and READMEs
should be automatically generated from these docstrings.

Motivation:

* The same help is available both via IRC and in the README
  (although the README can be more detailed, as only the first
  paragraph will be shown on IRC)
* This will allow auto-generating plugin help on docs.limnoria.net
  using the same content as the README, as it's sourced from the
  docstrings

Additionally, this converts all READMEs from Markdown to ReST,
because the documentation already uses ReST, and other docstrings
in the codebase are in ReST for this reason.

2021-04-05 17:42:31 +02:00

1.3 KiB

Raw Blame History

Documentation for the Status plugin for Supybot

Purpose

A simple module to handle various informational commands querying the bot's current status and statistics, like its uptime.

Usage

This plugin allows you to view different bot statistics, for example, uptime.

Commands

cmd takes no arguments: Returns some interesting command-related statistics.
commands takes no arguments: Returns a list of the commands offered by the bot.
cpu takes no arguments: Returns some interesting CPU-related statistics on the bot.
net takes no arguments: Returns some interesting network-related statistics.
network takes no arguments: Returns the network the bot is on.
processes takes no arguments: Returns the number of processes that have been spawned, and list of ones that are still active.
server takes no arguments: Returns the server the bot is on.
status takes no arguments: Returns the status of the bot.
threads takes no arguments: Returns the current threads that are active.
uptime takes no arguments: Returns the amount of time the bot has been running.

Configuration

supybot.plugins.Status.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

1.3 KiB Raw Blame History