1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# Pympress package
This page contains the inline documentation, generated from the code using sphinx.
The code is documented in the source using the [Google style](https://google.github.io/styleguide/pyguide.html) for docstrings. Sphinx has gathered a [set of examples](http://www.sphinx-doc.org/en/latest/ext/example_google.html) which serves as a better crash course than the full style reference.
Retructured text (rst) can be used inside the comments and docstrings.
## Modules
```eval_rst
.. automodule:: pympress.__main__
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.ui
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.document
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.builder
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.surfacecache
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.scribble
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.pointer
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.editable_label
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.talk_time
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.config
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.extras
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.util
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.media_overlays.base
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.media_overlays.gif_backend
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.media_overlays.gst_backend
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pympress.media_overlays.vlc_backend
:members:
:undoc-members:
:show-inheritance:
```
|
