Commit Graph

69 Commits

Author SHA1 Message Date
Valentin Lorentz
008b183f28 Make the plugin list a definition-list instead of the raw toctree
to show a short description of each plugin, instead of just
the long list of names.
2021-04-17 17:59:02 +02:00
Valentin Lorentz
ab99fac88d Start documenting the overall architecture 2021-04-11 20:37:48 +02:00
Valentin Lorentz
e00596feb0 plugin_tutorial: Add links to irc.replySuccess() and irc.error() 2021-04-05 21:32:07 +02:00
Valentin Lorentz
038490307f advanced_plugin_config: Add missing ref (needed by the plugin tutorial) 2021-04-05 20:35:16 +02:00
Valentin Lorentz
9d57257e6f plugin_tutorial: Rename Supybot to Limnoria
The tutorial doesn't need to confuse people about the subtle
difference between the two so early :)
2021-04-05 20:33:33 +02:00
Valentin Lorentz
9bad11dbc4 plugin_tutorial: Add some links and formatting. 2021-04-05 20:31:20 +02:00
Valentin Lorentz
41a9deddaa Add registry autodoc
will be referenced by the callbacks documentation in the next release.
2021-04-05 20:21:55 +02:00
Valentin Lorentz
44c7f6fc33 Import the supybot.schedule documentation from Gribble's wiki
It's good to reference it from the main doc; and I'd rather copy it here
in case the Gribble Wiki (or Sourceforge) goes down.
2021-04-05 18:40:35 +02:00
Valentin Lorentz
25847931cf plugin_distribution: Explain how to install with pip from a git subdir 2021-03-11 21:18:00 +01:00
Valentin Lorentz
e15ea8686a develop: add missing link to the FAQ. 2020-10-13 22:46:17 +02:00
Valentin Lorentz
afd0da4f73 advanced_plugin_testing.rst: remove note about supybot/gribble compatibility.
They are not longer developed.
2020-10-02 18:43:46 +02:00
Valentin Lorentz
d9e718d80e Start writing a FAQ for plugin developers. 2020-09-27 15:55:01 +02:00
Valentin Lorentz
b6e426b9d5 Update autodoc of irclib to work better with the current doc in testing. 2020-09-27 15:26:45 +02:00
Valentin Lorentz
798c58d726 Restructure dev documentation to make more sense on the front page. 2020-06-06 16:51:57 +02:00
Valentin Lorentz
eded7e6a75 Remove note on %S, %T, and %v.
There are available since 2011, 2013, and 2011 respectively, and not
worth mentioning anymore.
2020-06-06 15:35:16 +02:00
Valentin Lorentz
0c3facdf75 Document plugin distribution (both traditional and the new setuptools-based one). 2020-05-08 19:17:42 +02:00
Valentin Lorentz
300e270151 Update config tutorial to use network-specific values of variables. 2020-04-07 21:35:30 +02:00
James Lu
5e00c9816d Point support channel to #limnoria @ freenode
Supybot upstream is technically EOL.
2020-03-18 23:42:47 -07:00
James Lu
4978d30922 plugin_tutorial: reflect changes made to __contributors__ handling 2020-03-14 11:12:20 -07:00
James Lu
b057b39e33 plugin_tutorial: update __init__.py example to match Python 3 syntax 2020-03-14 11:11:24 -07:00
James Lu
595fe05512 adv_plugin_testing: fix missing arg to getMsg()
Closes GH-80.
2017-08-30 23:12:34 -07:00
Valentin Lorentz
b7347a4a3e Warn about indentation in the plugin tuto. 2016-10-27 20:07:30 +02:00
Valentin Lorentz
16a578cd71 using_wrap: Group converters and contexts in logical groups. 2016-02-19 22:17:06 +01:00
Valentin Lorentz
e1f80be983 Merge pull request #50 from GLolol/patch-2
using_wrap.rst: fix a typo
2015-01-25 19:49:45 +01:00
Mikaela Suomalainen
be01de9224 advanced_plugin_testing: fix underline
Next error is something where I cannot say anything.

```
/home/mikaela/src/github/mikaela/limnoria-doc/develop/callbacks.rst:11:
WARNING: py:class reference target not found: NestedCommandsIrcProxy
```
2014-12-28 10:58:32 +02:00
GLolol
4d18defd35 using_wrap.rst: fix a typo 2014-12-17 08:05:55 -08:00
GLolol
0d978be260 advanced_plugin_testing.rst: Fix a couple of typos 2014-11-19 17:43:23 -08:00
KingInTheNorth
3e631f350c Fixed from README.txt to .md
README.txt is outdated, the wizard now makes a README.md file.
2014-08-31 12:00:59 -05:00
Mikaela Suomalainen
fc486ed212 Use gender neutral pronouns 2014-08-28 14:43:41 +03:00
Mikaela Suomalainen
e8a0590f48 develop/httpserver.rst: fix links & HTML5
All links to the plugins went to ProgVal/Limnoria, most of them are
really at ProgVal/Supybot-plugins.

Code examples now use HTML5.
2014-07-30 17:46:07 +03:00
Valentin Lorentz
a69a0e975d Fix typo. 2014-07-30 07:32:38 +00:00
Mikaela Suomalainen
ff51741876 develop/index.rst: remove ircdb.rst
from library reference. It doesn't appear in generated documentation and
makes the builds to fail.
2014-06-30 23:05:08 +03:00
Valentin Lorentz
1867b29e27 Fix typo. 2014-01-26 22:31:46 +01:00
Valentin Lorentz
600ccdbd3e Document plugins' __init__() and die(). 2014-01-26 22:07:51 +01:00
Valentin Lorentz
bf25eaace0 Document invalidCommand and at a pointer to PluginRegexp in the events documentation. 2014-01-21 13:44:42 +01:00
Valentin Lorentz
0305de96c8 Improve doc of supybot.callbacks. 2014-01-21 13:44:19 +01:00
Valentin Lorentz
a7ab5420aa Document configuration variables edits in unit tests. 2014-01-21 13:28:20 +01:00
Valentin Lorentz
37923abd07 Document callAfter and callBefore. 2014-01-20 13:51:10 +01:00
Valentin Lorentz
192c47af06 Update documentation of utils.str.format. 2014-01-20 13:48:01 +01:00
Valentin Lorentz
8dc9d73f0e Document inFilter and outFilter. 2014-01-20 13:35:42 +01:00
Valentin Lorentz
0e7c7fac45 Document pre-command-call hooks. 2014-01-20 12:02:24 +01:00
Valentin Lorentz
cf36da527d Document capabilities on the plugin side. 2014-01-20 11:54:27 +01:00
Valentin Lorentz
27a9a4764d Document commands handling on the plugin side. 2014-01-20 11:15:30 +01:00
Valentin Lorentz
2df3137061 Document dynamicScope. 2014-01-20 10:58:19 +01:00
Valentin Lorentz
6c3d4fa07c Document 'do-commands'. 2014-01-20 10:46:39 +01:00
Valentin Lorentz
0ba89a0425 Document generic variable access syntax. 2014-01-20 10:36:05 +01:00
Valentin Lorentz
68406e86e9 Fix typo in develop/advanced_plugin_config.rst. 2014-01-20 10:27:07 +01:00
Valentin Lorentz
644d236f97 Document read/write of configuration variables. 2014-01-20 10:16:17 +01:00
Valentin Lorentz
82e1866c0e Document channel-specific and private configuration variables. 2014-01-20 10:11:01 +01:00
Valentin Lorentz
68218a70d3 Fix develop/index.rst. 2014-01-20 09:48:25 +01:00