Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-25 13:39:31 +01:00
Code Issues Projects Releases Wiki Activity
300 Commits 2 Branches 0 Tags 723 KiB
008b183f28
Commit Graph

300 Commits

This Branch
This Branch
All Branches
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
78030615fb Update readme 2021-04-11 20:37:11 +02:00
Valentin Lorentz
71536bc9f9 Rewrite the plugin doc generation script so it actually works. 
Depends on Limnoria >= 2021.04.05, both for supybot-plugin-doc updates
and reorganized documentation in plugins
 2021-04-11 11:34:14 +02:00
Valentin Lorentz
f1e719a82d use/security: Document owner-less setup. 2021-04-10 16:21:23 +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
d1bf6cf576 use/install: fix typos 2021-04-05 11:57:41 +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
7e289290f3 use/faq: Add 'How do I create a command?' section 2021-02-07 22:05:19 +01:00
Valentin Lorentz
b8bd902927 use/getting_started: rename Supybot to Limnoria. 
It may have been confusing, to use the name Supybot everywhere: as the
software name, the shell commands, and the nick on IRC.
Plus, it's the Limnoria documentation, so let's avoid confusion this
early in the documentation.
 2020-10-13 22:47:30 +02:00
Valentin Lorentz
bc35413ad5 use/faq: reference the developer FAQ. 2020-10-13 22:46:38 +02: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
ccc507d164 security: add an item to hide the bot version. 2020-09-27 15:26:45 +02:00
Valentin Lorentz
eb17d3030f getting_started: fix mistake in plugin name. 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
f6f39ec02e Add supybot.reply.error.detailed to hardening options 2020-05-13 21:01:07 +02:00
Valentin Lorentz
c537a0bf93 Add tips to deal with command abuse. 2020-05-13 20:48:04 +02:00
Valentin Lorentz
c26f7a8235 Update note on CA validation wrt. Python versions. 
We no longer support versions without CA validation.
 2020-05-13 20:47:51 +02:00
Valentin Lorentz
9c1604e39e Add more examples of capability management. 2020-05-13 19:57:09 +02:00
Valentin Lorentz
e6c5c3a04c Fix typos. 2020-05-13 19:56:44 +02:00
Valentin Lorentz
72c2a684c0 Add an introduction. 2020-05-08 19:27:56 +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
793e63bbdb Hide version number, it's not relevant. 
Compatility breakages are rare, and there are notes in the docs
whenever this happens.
 2020-04-26 12:30:18 +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
c0292e42ca contribute/develop: typo fixes 2020-03-18 23:42:04 -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
Louis-Philippe Véronneau
521eb14e04 fix minor typo 2019-10-18 21:48:21 +02:00
Valentin Lorentz
b22c798b68
Mention that GPG/NickAuth have to be loaded. 2018-10-11 19:40:50 +02:00
Valentin Lorentz
66d225649b Git is not needed anymore. 2018-03-09 05:37:35 +01:00
Valentin Lorentz
1af914e452 Document supybot.commands.allowShell. 2018-02-04 12:07:15 +01:00
Valentin Lorentz
dfad42bc1c fix grammatical ambiguity. 2018-02-04 11:56:55 +01:00
Valentin Lorentz
f7593a1751 systemd sandboxing 2017-09-18 19:51:18 +02:00
Valentin Lorentz
b9e29a8eec Merge pull request #83 from GLolol/patch-1 
adv_plugin_testing: add missing arg to getMsg()
 2017-09-17 15:10:28 +02: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
3e5eba6298 Merge pull request #81 from EmilePouget/master 
use/install.rst: Add install instructions for Guix and GuixSD
 2017-05-06 14:36:50 +02:00
ng0
f0a3e91630 use/install.rst: Add install instructions for Guix and GuixSD 2017-05-03 19:31:31 +00:00
Valentin Lorentz
48128a9a63 Fix systemd unit. 2017-05-03 21:31:30 +02:00
Valentin Lorentz
b7347a4a3e Warn about indentation in the plugin tuto. 2016-10-27 20:07:30 +02:00
Valentin Lorentz
db20cba8ce Merge pull request #78 from jflory7/patch-1 
Remove sneaky backtick
 2016-08-07 21:26:13 +02:00