]> kaliko git repositories - sid.git/blob - doc/source/doc.rst
doc: Improve and update
[sid.git] / doc / source / doc.rst
1 Development documentation
2 =========================
3
4 The Bot
5 -------
6
7 .. autoclass:: sid.sid.MUCBot
8     :members:
9     :undoc-members:
10     :show-inheritance:
11
12 .. need sphinx v2.0 for autodecorator
13 .. autodecorator:: sid.sid.botcmd(hidden, name)
14
15 Plugin base
16 -----------
17
18 The plugin class to derive from.
19
20 .. autoclass:: sid.plugin.Plugin
21     :members:
22     :undoc-members:
23
24 .. vim: spell spelllang=en
25
26
27 Available plugins
28 -----------------
29
30 Generic plugins
31 ~~~~~~~~~~~~~~~
32
33 .. automodule:: sid.echo
34     :members:
35     :show-inheritance:
36
37 .. autoclass:: sid.feeds.Feeds
38     :members:
39     :show-inheritance:
40
41 .. automodule:: sid.log
42     :members:
43     :show-inheritance:
44
45 .. autoclass:: sid.rtbl.RTBL
46     :members:
47     :show-inheritance:
48
49 Debian plugins
50 ~~~~~~~~~~~~~~
51
52 .. automodule:: sid.archive
53     :members:
54     :show-inheritance:
55
56 .. automodule:: sid.bts
57     :members:
58     :show-inheritance:
59
60 .. vim: spell spelllang=en