mirror of https://github.com/Mikaela/Limnoria.git synced 2024-10-06 19:38:50 +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

2.8 KiB

Raw Blame History

Documentation for the PluginDownloader plugin for Supybot

Purpose

This plugin allows you to quickly download and install a plugin from other repositories.

Usage

This plugin allows you to install unofficial plugins from multiple repositories easily. Use the "repolist" command to see list of available repositories and "repolist <repository>" to list plugins, which are available in that repository. When you want to install a plugin, just run command "install <repository> <plugin>".

First start by using the plugindownloader repolist command to see the available repositories.

To see the plugins inside repository, use command plugindownloader repolist <repository>

When you see anything interesting, you can use plugindownloader info <repository> <plugin> to see what the plugin is for.

And finally to install the plugin, plugindownloader install <repository> <plugin>.

Examples

< Mikaela> @load PluginDownloader
< Limnoria> Ok.
< Mikaela> @plugindownloader repolist
< Limnoria> Antibody, GLolol, Hoaas, Iota, ProgVal, SpiderDave, boombot, code4lib, code4lib-edsu, code4lib-snapshot, doorbot, frumious, jonimoose, mailed-notifier, mtughan-weather, nanotube-bitcoin, nyuszika7h, nyuszika7h-old, pingdom, quantumlemur, resistivecorpse, scrum, skgsergio, stepnem
< Mikaela> @plugindownloader repolist ProgVal
< Limnoria> AttackProtector, AutoTrans, Biography, Brainfuck, ChannelStatus, Cleverbot, Coffee, Coinpan, Debian, ERepublik, Eureka, Fortune, GUI, GitHub, Glob2Chan, GoodFrench, I18nPlaceholder, IMDb, IgnoreNonVoice, Iwant, Kickme, LimnoriaChan, LinkRelay, ListEmpty, Listener, Markovgen, MegaHAL, MilleBornes, NoLatin1, NoisyKarma, OEIS, PPP, PingTime, Pinglist, RateLimit, Rbls, Redmine, Scheme, Seeks, (1 more message)
< Mikaela> more
< Limnoria> SilencePlugin, StdoutCapture, Sudo, SupyML, SupySandbox, TWSS, Trigger, Trivia, Twitter, TwitterStream, Untiny, Variables, WebDoc, WebLogs, WebStats, Website, WikiTrans, Wikipedia, WunderWeather
< Mikaela> @plugindownloader info ProgVal Wikipedia
< Limnoria> Grabs data from Wikipedia.
< Mikaela> @plugindownloader install ProgVal Wikipedia
< Limnoria> Ok.
< Mikaela> @load Wikipedia
< Limnoria> Ok.

Commands

info <repository> <plugin>: Displays informations on the <plugin> in the <repository>.
install <repository> <plugin>: Downloads and installs the <plugin> from the <repository>.
repolist [<repository>]: Displays the list of plugins in the <repository>. If <repository> is not given, returns a list of available repositories.

Configuration

supybot.plugins.PluginDownloader.public

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

Determines whether this plugin is publicly visible.

2.8 KiB Raw Blame History