0fdd1e70e1
Rework the config developers reference
...
- Remove redundant language. Focus on the key functions / classes and their inputs
- Add an example for registerNetworkValue()
- Describe the behaviour difference of private values
- Consistently use `plugins.WorldDom.attackTargets.air` in examples (previously it was inconsistent with `plugins.WorldDom.air`)
- Format types with :class:
- Remove fallback code for supybot / gribble. These are Py2-only and unlikely to be relevant these days
2025-02-09 10:34:01 +01:00
6d7d86289a
plugin_tutorial: further simplifications
...
- Remove the discussion of README and copyright header. These are already very self documenting
- Add links to the `help` syntax reference in use/getting_started
- Update the headings to include the contents of each file in addition to its name for easier navigation
- Further remove redundant language
2025-02-08 21:13:20 +01:00
676ee3a58d
Rewrite the commands.wrap guide
...
- Add concrete examples of contexts: optional and multiple arguments
- Add examples of converters that don't (always) read command line arguments, such as 'op' and 'channel'
- Switch examples to use the decorator syntax for "wrap". This is common among chatbots these days
- Make the motivating example more concise
2025-02-05 09:14:30 +01:00
8ce98eb38c
Actually they are called after updating IrcState
2024-02-13 21:22:06 +01:00
46fa8ec799
Mention that do-methods are called before updating IrcState
2024-02-13 21:19:28 +01:00
ebb19029e6
using_wrap: Fix definition-list formatting
2023-06-10 16:45:16 +02:00
7cc6b1f9f8
Apply suggestions from code review
...
Co-authored-by: Val Lorentz <progval+git@progval.net>
2023-05-11 08:08:52 -07:00
b0c881f41b
plugin_tutorial: consistently use the decorator @wrap syntax
2023-05-11 08:08:52 -07:00
007b64edb7
plugin_tutorial: use dedent=0
2023-05-11 08:08:52 -07:00
a88f291096
plugin_tutorial: fill in note about irc in plugin constructor
2023-05-11 08:08:52 -07:00
94784eb88d
plugin_tutorial: wording tweaks
2023-05-11 08:08:52 -07:00
5e63c271b6
plugin_tutorial: revise / condense test.py section and conclusion
2023-05-11 08:08:52 -07:00
14ffe24e7a
plugin_tutorial: link directly to supybot.ircmsgs.IrcMsg
...
Co-authored-by: Val Lorentz <progval+git@progval.net>
2023-05-11 08:08:52 -07:00
54f94be56d
plugin_tutorial: rewrite / condense plugin.py section
...
- Add additional inline links to related doc pages
- Mention additional common uses of irc.reply and irc.error
2023-05-11 08:08:52 -07:00
fa43baf9a8
advanced_plugin_config: move configure (supybot-wizard) part further down
...
For 3rd party plugins this is so seldomly used it doesn't need to be front and center. Let's have the more important bits further up.
2023-05-11 08:08:52 -07:00
6e59457c5b
plugin_tutorial: rewrite and condense __init__ and config.py sections
2023-05-11 08:08:52 -07:00
d8bd095127
plugin_tutorial: rewrite and condense up to first half of __init__.py
...
- Suggest running supybot-plugin-create in a separate folder, as it helps with organization
- Update supybot-plugin-create example: it now asks more questions and fills in a lot of the doc fields for you
2023-05-11 08:08:52 -07:00
c4f477a4d4
develop/style: fix indent error
2023-04-30 11:56:21 -07:00
c6b501897e
Reword feature support notes about Supybot and Gribble
...
Neither of those are active anymore, so we shouldn't expect them to ever merge the new code really.
2023-04-30 11:45:25 -07:00
abf93c3180
plugin_tutorial: Supybot/Limnoria -> Limnoria
2023-04-30 11:45:25 -07:00
8e0582c325
develop: use new super() syntax to call parent constructors
2023-04-30 11:45:25 -07:00
b775986c38
style: copyedit, remove clauses that duplicate PEP8
2023-04-29 11:07:29 -07:00
29b3b2ed09
develop/httpserver: modernize import and super() calls
2022-07-26 08:16:24 +02:00
93cb169e8c
architecture: Fix references
2022-04-24 10:57:58 +02:00
de2f671229
architecture: Fix typos
2022-04-24 10:49:43 +02:00
b4b52e2c7c
Reference modern-irc spec when relevant
2022-03-17 21:31:55 +01:00
7a41dc185d
irclib: Fix typo in the introduction of ChannelState
2022-03-08 22:44:30 +01:00
6e203b9f78
plugin_distribution: Remove warning about the pip method being experimental
2022-02-05 16:51:54 +01:00
d29257f1d9
plugin_distribution: Recommend installing from git repos first, it's easier than PyPI
2022-02-05 16:51:54 +01:00
604de68302
Move FAQ item to the right page.
2021-12-28 23:38:53 +01:00
dab8ca3d87
plugin_distribution: Make it clearer PyPI is optional
2021-10-28 23:14:46 +02:00
dc97a84f30
Freenode -> Libera
...
Signed-off-by: Georg <georg@lysergic.dev>
2021-07-17 20:44:55 +02:00
628f2a0864
Freenode -> Libera ( #93 )
2021-07-17 10:40:01 -07:00
ff7432f929
update links http -> https & fix linkrots
2021-06-29 17:41:51 +02:00
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
ab99fac88d
Start documenting the overall architecture
2021-04-11 20:37:48 +02:00
e00596feb0
plugin_tutorial: Add links to irc.replySuccess() and irc.error()
2021-04-05 21:32:07 +02:00
038490307f
advanced_plugin_config: Add missing ref (needed by the plugin tutorial)
2021-04-05 20:35:16 +02:00
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
9bad11dbc4
plugin_tutorial: Add some links and formatting.
2021-04-05 20:31:20 +02:00
41a9deddaa
Add registry autodoc
...
will be referenced by the callbacks documentation in the next release.
2021-04-05 20:21:55 +02:00
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
25847931cf
plugin_distribution: Explain how to install with pip from a git subdir
2021-03-11 21:18:00 +01:00
e15ea8686a
develop: add missing link to the FAQ.
2020-10-13 22:46:17 +02:00
afd0da4f73
advanced_plugin_testing.rst: remove note about supybot/gribble compatibility.
...
They are not longer developed.
2020-10-02 18:43:46 +02:00
d9e718d80e
Start writing a FAQ for plugin developers.
2020-09-27 15:55:01 +02:00
b6e426b9d5
Update autodoc of irclib to work better with the current doc in testing.
2020-09-27 15:26:45 +02:00
798c58d726
Restructure dev documentation to make more sense on the front page.
2020-06-06 16:51:57 +02:00
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
0c3facdf75
Document plugin distribution (both traditional and the new setuptools-based one).
2020-05-08 19:17:42 +02:00
