mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01: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

962 B

Raw Blame History

Documentation for the Hashes plugin for Supybot

Purpose

Provides various hash- and encryption-related commands.

Usage

Provides hash or encryption related commands

Commands

algorithms <takes no arguments>: Returns the list of available algorithms.
md5 <text>: Returns the md5 hash of a given string.
mkhash <algorithm> <text>: Returns TEXT after it has been hashed with ALGORITHM. See the 'algorithms' command in this plugin to return the algorithms available on this system.
sha <text>: Returns the SHA1 hash of a given string.
sha256 <text>: Returns a SHA256 hash of the given string.
sha512 <text>: Returns a SHA512 hash of the given string.

Configuration

supybot.plugins.Hashes.public

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

Determines whether this plugin is publicly visible.

962 B Raw Blame History