← Back to branch summary

~codeforger/pypal/docs

« back to all changes in this revision

Viewing changes to docs/pypal.body.rst

  • Committer: Michael Rochester
  • Date: 2014-07-20 14:25:45 UTC
  • Revision ID: m.rochester93@googlemail.com-20140720142545-z14oaetu1ls4hy4s
updated some documentation and switched the implimentation of the character class to be a generic body.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/pypal.body.rst
7
7
.. autoclass:: pypal.body.Box
8
8
    :members:
9
9
    :undoc-members:
10
 
    :show-inheritance:
 
10
    :inherited-members:
 
11
    :exclude-members: delete
11
12
 
12
13
.. autoclass:: pypal.body.StaticBox
13
14
    :members:
14
15
    :undoc-members:
15
 
    :show-inheritance:
 
16
    :inherited-members:
 
17
    :exclude-members: delete
16
18
 
17
19
:class:`Capsule` module
18
20
-------------------------
20
22
.. autoclass:: pypal.body.Capsule
21
23
    :members:
22
24
    :undoc-members:
23
 
    :show-inheritance:
 
25
    :inherited-members:
 
26
    :exclude-members: delete
24
27
 
25
28
.. autoclass:: pypal.body.StaticCapsule
26
29
    :members:
27
30
    :undoc-members:
28
 
    :show-inheritance:
 
31
    :inherited-members:
 
32
    :exclude-members: delete
29
33
 
30
34
:class:`Character` module
31
35
---------------------------
33
37
.. autoclass:: pypal.body.Character
34
38
    :members:
35
39
    :undoc-members:
36
 
    :show-inheritance:
 
40
    :inherited-members:
 
41
    :exclude-members: delete
37
42
 
38
43
:class:`Compound` module
39
44
--------------------------
41
46
.. autoclass:: pypal.body.Compound
42
47
    :members:
43
48
    :undoc-members:
44
 
    :show-inheritance:
 
49
    :inherited-members:
 
50
    :exclude-members: delete
45
51
 
46
52
.. autoclass:: pypal.body.StaticCompound
47
53
    :members:
48
54
    :undoc-members:
49
 
    :show-inheritance:
 
55
    :inherited-members:
 
56
    :exclude-members: delete
50
57
 
51
58
:class:`Convex` module
52
59
------------------------
54
61
.. autoclass:: pypal.body.Convex
55
62
    :members:
56
63
    :undoc-members:
57
 
    :show-inheritance:
 
64
    :inherited-members:
 
65
    :exclude-members: delete
58
66
 
59
67
.. autoclass:: pypal.body.StaticConvex
60
68
    :members:
61
69
    :undoc-members:
62
 
    :show-inheritance:
 
70
    :inherited-members:
 
71
    :exclude-members: delete
63
72
 
64
73
:class:`GenericBody` module
65
74
------------------------------
67
76
.. autoclass:: pypal.body.GenericBody
68
77
    :members:
69
78
    :undoc-members:
70
 
    :show-inheritance:
 
79
    :inherited-members:
 
80
    :exclude-members: delete
71
81
 
72
82
:class:`Ghost` module
73
83
-----------------------
75
85
.. autoclass:: pypal.body.Ghost
76
86
    :members:
77
87
    :undoc-members:
78
 
    :show-inheritance:
 
88
    :inherited-members:
 
89
    :exclude-members: delete
79
90
 
80
91
:class:`Sphere` module
81
92
------------------------
83
94
.. autoclass:: pypal.body.Sphere
84
95
    :members:
85
96
    :undoc-members:
86
 
    :show-inheritance:
 
97
    :inherited-members:
 
98
    :exclude-members: delete
87
99
 
88
100
.. autoclass:: pypal.body.StaticSphere
89
101
    :members:
90
102
    :undoc-members:
91
 
    :show-inheritance:
 
103
    :inherited-members:
 
104
    :exclude-members: delete
92
105
 
93
106
 
94
107
Module contents
97
110
.. autoclass:: pypal.body
98
111
    :members:
99
112
    :undoc-members:
100
 
    :show-inheritance:
 
113
    :inherited-members:
 
114
    :exclude-members: delete