Skip to content

Commit a794a0f

Browse files
committed
More docs and restructure
1 parent efe8747 commit a794a0f

File tree

11 files changed

+373
-363
lines changed

11 files changed

+373
-363
lines changed

docs/user_guide/controls.rst renamed to docs/controls.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Basic Keyboard Controls
77

88
- ``ESC`` to exit
99
- ``SPACE`` to pause the current time (tells the configured timer to pause)
10-
- ``X`` for taking a screenshot (output path is configurable in settings)
10+
- ``X`` for taking a screenshot (output path is configurable in :doc:`settings`)
1111

1212
Camera Controls
1313
^^^^^^^^^^^^^^^
@@ -23,7 +23,7 @@ Simply apply the ``view_matrix`` of the camera to your transformations.
2323
- ``D`` strafe right
2424
- ``Q`` down the y axis
2525
- ``E`` up the y axis
26-
- ``R`` reload all shaders
26+
- ``R`` reload shader programs (Needs configuration)
2727

2828
**Mouse Controls**
2929

docs/index.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,35 @@ A Python 3 cross platform OpenGL 3.3+ core framework based on `ModernGL <https:/
88
| |screenshot1| | |screenshot2| |
99
+-----------------+-----------------+
1010

11+
.. warning:: The documentation for 2.0 is currently work in progress and you may find some sections outdated
1112

12-
User Guide
13-
----------
13+
.. toctree::
14+
:maxdepth: 2
15+
:caption: Getting Started
1416

15-
This is the user guide
17+
quickstart
1618

1719
.. toctree::
1820
:maxdepth: 2
21+
:caption: User Guide
1922

20-
user_guide/quickstart
21-
user_guide/controls
2223
user_guide/index
23-
24-
Reference
25-
---------
24+
controls
2625

2726
.. toctree::
28-
:maxdepth: 1
27+
:maxdepth: 2
28+
:caption: Reference
2929

30-
reference/effect
31-
reference/settings
30+
reference/index
31+
32+
.. toctree::
33+
:maxdepth: 2
34+
:caption: Settings
3235

36+
settings
3337

3438
Indices and tables
35-
==================
39+
------------------
3640

3741
* :ref:`genindex`
3842
* :ref:`modindex`

docs/user_guide/quickstart.rst renamed to docs/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ We should now have the following structure:
8686
cube
8787
├── effects.py
8888
├── dependencies.py
89-
└── resoruces
89+
└── resources
9090
└── programs
9191
   └── cube
9292
   └── default.glsl

docs/reference/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
Reference
3+
=========
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
8+
effect
9+
vao
10+
geometry

docs/reference/settings.rst

Lines changed: 0 additions & 231 deletions
This file was deleted.

0 commit comments

Comments
 (0)