Skip to content

Commit 378e3c8

Browse files
einarfeinarf
committed
CRLF -> LF in rst files
1 parent 72e2ad2 commit 378e3c8

15 files changed

+367
-363
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ __pycache__
77
/demosys_py.egg-info
88
/dist
99
/docs/build
10+
/docs/_build
1011
.pytest_cache
1112
/screenshots
1213

‎docs/controls.rst

+32-32
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
2-
Controls
3-
========
4-
5-
Basic Keyboard Controls
6-
^^^^^^^^^^^^^^^^^^^^^^^
7-
8-
- ``ESC`` to exit
9-
- ``SPACE`` to pause the current time (tells the configured timer to pause)
10-
- ``X`` for taking a screenshot (output path is configurable in :doc:`settings`)
11-
- ``R`` reload shader programs (Needs configuration)
12-
- ``LEFT`` jump 10 seconds back in time
13-
- ``RIGHT`` jump 10 seconds forward in time
14-
15-
Camera Controls
16-
^^^^^^^^^^^^^^^
17-
18-
You can include a system camera in your effects through ``self.sys_camera``.
19-
Simply apply the ``view_matrix`` of the camera to your transformations.
20-
21-
**Keyboard Controls**:
22-
23-
- ``W`` forward
24-
- ``S`` backwards
25-
- ``A`` strafe left
26-
- ``D`` strafe right
27-
- ``Q`` down the y axis
28-
- ``E`` up the y axis
29-
30-
**Mouse Controls**
31-
32-
- Standard yaw/pitch camera rotation with mouse
1+
2+
Controls
3+
========
4+
5+
Basic Keyboard Controls
6+
^^^^^^^^^^^^^^^^^^^^^^^
7+
8+
- ``ESC`` to exit
9+
- ``SPACE`` to pause the current time (tells the configured timer to pause)
10+
- ``X`` for taking a screenshot (output path is configurable in :doc:`settings`)
11+
- ``R`` reload shader programs (Needs configuration)
12+
- ``LEFT`` jump 10 seconds back in time
13+
- ``RIGHT`` jump 10 seconds forward in time
14+
15+
Camera Controls
16+
^^^^^^^^^^^^^^^
17+
18+
You can include a system camera in your effects through ``self.sys_camera``.
19+
Simply apply the ``view_matrix`` of the camera to your transformations.
20+
21+
**Keyboard Controls**:
22+
23+
- ``W`` forward
24+
- ``S`` backwards
25+
- ``A`` strafe left
26+
- ``D`` strafe right
27+
- ``Q`` down the y axis
28+
- ``E`` up the y axis
29+
30+
**Mouse Controls**
31+
32+
- Standard yaw/pitch camera rotation with mouse

‎docs/reference/demosys.context.base.rst

+37-37
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
2-
.. py:module:: demosys.context.base
3-
.. py:currentmodule:: demosys.context.base
4-
5-
demosys.context.base.BaseWindow
6-
===============================
7-
8-
.. autodata:: BaseWindow
9-
:annotation:
10-
11-
.. autodata:: BaseKeys
12-
:annotation:
13-
14-
Methods
15-
-------
16-
17-
.. automethod:: BaseWindow.__init__
18-
.. automethod:: BaseWindow.draw
19-
.. automethod:: BaseWindow.clear
20-
.. automethod:: BaseWindow.clear_values
21-
.. automethod:: BaseWindow.use
22-
.. automethod:: BaseWindow.swap_buffers
23-
.. automethod:: BaseWindow.resize
24-
.. automethod:: BaseWindow.close
25-
.. automethod:: BaseWindow.should_close
26-
.. automethod:: BaseWindow.terminate
27-
.. automethod:: BaseWindow.keyboard_event
28-
.. automethod:: BaseWindow.cursor_event
29-
.. automethod:: BaseWindow.print_context_info
30-
.. automethod:: BaseWindow.set_default_viewport
31-
32-
Attributes
33-
----------
34-
35-
.. autoattribute:: BaseWindow.size
36-
.. autoattribute:: BaseWindow.buffer_size
37-
.. autoattribute:: BaseWindow.keys
1+
2+
.. py:module:: demosys.context.base
3+
.. py:currentmodule:: demosys.context.base
4+
5+
demosys.context.base.BaseWindow
6+
===============================
7+
8+
.. autodata:: BaseWindow
9+
:annotation:
10+
11+
.. autodata:: BaseKeys
12+
:annotation:
13+
14+
Methods
15+
-------
16+
17+
.. automethod:: BaseWindow.__init__
18+
.. automethod:: BaseWindow.draw
19+
.. automethod:: BaseWindow.clear
20+
.. automethod:: BaseWindow.clear_values
21+
.. automethod:: BaseWindow.use
22+
.. automethod:: BaseWindow.swap_buffers
23+
.. automethod:: BaseWindow.resize
24+
.. automethod:: BaseWindow.close
25+
.. automethod:: BaseWindow.should_close
26+
.. automethod:: BaseWindow.terminate
27+
.. automethod:: BaseWindow.keyboard_event
28+
.. automethod:: BaseWindow.cursor_event
29+
.. automethod:: BaseWindow.print_context_info
30+
.. automethod:: BaseWindow.set_default_viewport
31+
32+
Attributes
33+
----------
34+
35+
.. autoattribute:: BaseWindow.size
36+
.. autoattribute:: BaseWindow.buffer_size
37+
.. autoattribute:: BaseWindow.keys

‎docs/reference/demosys.context.glfw.rst

+47-47
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
1-
2-
.. py:module:: demosys.context.glwf
3-
.. py:currentmodule:: demosys.context.glfw
4-
5-
demosys.context.glfw.Window
6-
===========================
7-
8-
.. autodata:: Window
9-
:annotation:
10-
11-
.. autodata:: Keys
12-
:annotation:
13-
14-
Methods
15-
-------
16-
17-
.. automethod:: Window.__init__
18-
.. automethod:: Window.use
19-
.. automethod:: Window.swap_buffers
20-
.. automethod:: Window.resize
21-
.. automethod:: Window.close
22-
.. automethod:: Window.should_close
23-
.. automethod:: Window.terminate
24-
.. automethod:: Window.key_event_callback
25-
.. automethod:: Window.mouse_event_callback
26-
.. automethod:: Window.window_resize_callback
27-
.. automethod:: Window.poll_events
28-
.. automethod:: Window.check_glfw_version
29-
30-
Other Inherited Methods
31-
-----------------------
32-
33-
.. automethod:: Window.draw
34-
.. automethod:: Window.clear
35-
.. automethod:: Window.clear_values
36-
.. automethod:: Window.keyboard_event
37-
.. automethod:: Window.cursor_event
38-
.. automethod:: Window.print_context_info
39-
.. automethod:: Window.set_default_viewport
40-
41-
Attributes
42-
----------
43-
44-
.. autoattribute:: Window.size
45-
.. autoattribute:: Window.buffer_size
46-
.. autoattribute:: Window.keys
47-
.. autoattribute:: Window.min_glfw_version
1+
2+
.. py:module:: demosys.context.glwf
3+
.. py:currentmodule:: demosys.context.glfw
4+
5+
demosys.context.glfw.Window
6+
===========================
7+
8+
.. autodata:: Window
9+
:annotation:
10+
11+
.. autodata:: Keys
12+
:annotation:
13+
14+
Methods
15+
-------
16+
17+
.. automethod:: Window.__init__
18+
.. automethod:: Window.use
19+
.. automethod:: Window.swap_buffers
20+
.. automethod:: Window.resize
21+
.. automethod:: Window.close
22+
.. automethod:: Window.should_close
23+
.. automethod:: Window.terminate
24+
.. automethod:: Window.key_event_callback
25+
.. automethod:: Window.mouse_event_callback
26+
.. automethod:: Window.window_resize_callback
27+
.. automethod:: Window.poll_events
28+
.. automethod:: Window.check_glfw_version
29+
30+
Other Inherited Methods
31+
-----------------------
32+
33+
.. automethod:: Window.draw
34+
.. automethod:: Window.clear
35+
.. automethod:: Window.clear_values
36+
.. automethod:: Window.keyboard_event
37+
.. automethod:: Window.cursor_event
38+
.. automethod:: Window.print_context_info
39+
.. automethod:: Window.set_default_viewport
40+
41+
Attributes
42+
----------
43+
44+
.. autoattribute:: Window.size
45+
.. autoattribute:: Window.buffer_size
46+
.. autoattribute:: Window.keys
47+
.. autoattribute:: Window.min_glfw_version

‎docs/reference/demosys.context.headless.rst

+40-40
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
2-
.. py:module:: demosys.context.headless
3-
.. py:currentmodule:: demosys.context.headless
4-
5-
demosys.context.headless.Window
6-
===============================
7-
8-
.. autodata:: Window
9-
:annotation:
10-
11-
Methods
12-
-------
13-
14-
.. automethod:: Window.__init__
15-
.. automethod:: Window.draw
16-
.. automethod:: Window.use
17-
.. automethod:: Window.should_close
18-
.. automethod:: Window.close
19-
.. automethod:: Window.resize
20-
.. automethod:: Window.swap_buffers
21-
.. automethod:: Window.terminate
22-
23-
Other Inherited Methods
24-
-----------------------
25-
26-
.. automethod:: Window.set_default_viewport
27-
.. automethod:: Window.cursor_event
28-
.. automethod:: Window.keyboard_event
29-
.. automethod:: Window.clear
30-
.. automethod:: Window.clear_values
31-
.. automethod:: Window.print_context_info
32-
33-
34-
Attributes
35-
----------
36-
37-
.. autoattribute:: Window.size
38-
.. autoattribute:: Window.buffer_size
39-
.. autoattribute:: Window.keys
40-
1+
2+
.. py:module:: demosys.context.headless
3+
.. py:currentmodule:: demosys.context.headless
4+
5+
demosys.context.headless.Window
6+
===============================
7+
8+
.. autodata:: Window
9+
:annotation:
10+
11+
Methods
12+
-------
13+
14+
.. automethod:: Window.__init__
15+
.. automethod:: Window.draw
16+
.. automethod:: Window.use
17+
.. automethod:: Window.should_close
18+
.. automethod:: Window.close
19+
.. automethod:: Window.resize
20+
.. automethod:: Window.swap_buffers
21+
.. automethod:: Window.terminate
22+
23+
Other Inherited Methods
24+
-----------------------
25+
26+
.. automethod:: Window.set_default_viewport
27+
.. automethod:: Window.cursor_event
28+
.. automethod:: Window.keyboard_event
29+
.. automethod:: Window.clear
30+
.. automethod:: Window.clear_values
31+
.. automethod:: Window.print_context_info
32+
33+
34+
Attributes
35+
----------
36+
37+
.. autoattribute:: Window.size
38+
.. autoattribute:: Window.buffer_size
39+
.. autoattribute:: Window.keys
40+

‎docs/reference/demosys.context.pyglet.rst

+29-29
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
2-
.. py:module:: demosys.context.pyglet
3-
.. py:currentmodule:: demosys.context.pyglet
4-
5-
demosys.context.pyglet.Window
6-
=============================
7-
8-
.. autodata:: Window
9-
:annotation:
10-
11-
.. autodata:: Keys
12-
:annotation:
13-
14-
Methods
15-
-------
16-
17-
.. automethod:: Window.__init__
18-
.. automethod:: Window.on_key_press
19-
.. automethod:: Window.on_key_release
20-
.. automethod:: Window.on_mouse_motion
21-
.. automethod:: Window.on_resize
22-
.. automethod:: Window.use
23-
.. automethod:: Window.swap_buffers
24-
.. automethod:: Window.should_close
25-
.. automethod:: Window.close
26-
.. automethod:: Window.terminate
27-
28-
Attributes
29-
----------
1+
2+
.. py:module:: demosys.context.pyglet
3+
.. py:currentmodule:: demosys.context.pyglet
4+
5+
demosys.context.pyglet.Window
6+
=============================
7+
8+
.. autodata:: Window
9+
:annotation:
10+
11+
.. autodata:: Keys
12+
:annotation:
13+
14+
Methods
15+
-------
16+
17+
.. automethod:: Window.__init__
18+
.. automethod:: Window.on_key_press
19+
.. automethod:: Window.on_key_release
20+
.. automethod:: Window.on_mouse_motion
21+
.. automethod:: Window.on_resize
22+
.. automethod:: Window.use
23+
.. automethod:: Window.swap_buffers
24+
.. automethod:: Window.should_close
25+
.. automethod:: Window.close
26+
.. automethod:: Window.terminate
27+
28+
Attributes
29+
----------

0 commit comments

Comments
 (0)