]> scripts.mit.edu Git - wizard.git/blob - doc/module/wizard.install.rst
Update documentation coverage, add diagram.
[wizard.git] / doc / module / wizard.install.rst
1 :mod:`wizard.install`
2 =====================
3
4 .. automodule:: wizard.install
5
6 Classes
7 ----------------
8 .. autoclass:: Strategy
9     :members:
10 .. autoclass:: Arg
11     :members:
12 .. autoclass:: ArgSet
13     :members:
14 .. autoclass:: ArgHandler
15     :members:
16
17 Predefined classes
18 ------------------
19 .. autoclass:: WebArgSet
20     :show-inheritance:
21 .. autoclass:: MysqlArgSet
22     :show-inheritance:
23 .. autoclass:: AdminArgSet
24     :show-inheritance:
25 .. autoclass:: EmailArgSet
26     :show-inheritance:
27 .. autoclass:: ScriptsWebStrategy
28     :members:
29     :show-inheritance:
30 .. autoclass:: ScriptsMysqlStrategy
31     :members:
32     :show-inheritance:
33 .. autoclass:: ScriptsEmailStrategy
34     :members:
35     :show-inheritance:
36
37 Functions
38 ---------
39 .. autofunction:: fetch
40 .. autofunction:: attr_to_option
41 .. autofunction:: preloads
42
43 Exceptions
44 ----------
45 .. autoexception:: Error
46 .. autoexception:: Failure
47     :show-inheritance:
48 .. autoexception:: StrategyFailed
49     :show-inheritance:
50 .. autoexception:: UnrecognizedPreloads
51     :show-inheritance:
52     :members:
53 .. autoexception:: MissingRequiredParam
54     :show-inheritance:
55     :members: