Skip to content

Commit e910f51

Browse files
committed
hierarchy re-org
1 parent fefe47e commit e910f51

File tree

7 files changed

+59
-58
lines changed

7 files changed

+59
-58
lines changed

doc/about/introduction.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
What is Arcade?
2+
===============
3+
4+
Arcade is an easy-to-learn Python library for creating 2D video games. It is ideal for people learning to program, or developers that want to code a 2D game without learning a complex framework.
5+
6+
.. raw:: html
7+
8+
<div style="padding:55% 0 0 0;position:relative;">
9+
<iframe class="vimeo-video" src="https://player.vimeo.com/video/662273899?h=31bf92c415&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen title="Arcade Demo.mp4"></iframe>
10+
</div><script src="https://player.vimeo.com/api/player.js"></script>
11+
<p><a href="https://vimeo.com/662273899">Quick Arcade Library Introduction Video</a></p>

doc/api_docs/arcade.rst

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ for the Python Arcade library. See also:
3535
api/window
3636
api/sound
3737
api/path_finding
38-
api/version
3938
api/isometric
4039
api/earclip
4140
api/easing
@@ -47,7 +46,7 @@ for the Python Arcade library. See also:
4746

4847
.. toctree::
4948
:maxdepth: 1
50-
:caption: Arcade GUI
49+
:caption: GUI
5150

5251
api/gui
5352
api/gui_widgets
@@ -57,16 +56,8 @@ for the Python Arcade library. See also:
5756

5857
.. toctree::
5958
:maxdepth: 1
60-
:caption: Arcade Sub Modules
59+
:caption: Constants
6160

6261
arcade.key
6362
arcade.csscolor
6463
arcade.color
65-
66-
.. toctree::
67-
:maxdepth: 1
68-
:caption: Other Information
69-
70-
resources
71-
keyboard
72-

doc/contributing_guide/how_to_contribute.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _how-to-contribute:
22

3-
How to Contribute
3+
Ways to Contribute
44
=================
55

66
We would love to have you contribute to the project! There are several

doc/contributing_guide/index.rst

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,3 @@
22
.. _cg_index_quickstart:
33

44
.. include:: ../../CONTRIBUTING.rst
5-
6-
.. _cg_index_contents:
7-
8-
Contributing Guide Contents
9-
---------------------------
10-
11-
The sections linked below provide more in-depth coverage of various topics
12-
contributing to arcade, including links to outside resources on development tools
13-
and practices.
14-
15-
.. toctree::
16-
:maxdepth: 1
17-
18-
directory_structure
19-
how_to_contribute
20-
how_to_submit_changes
21-
release_checklist

doc/index.rst

Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
The Python Arcade Library
1010
=========================
1111

12+
Arcade is an easy-to-learn Python library for creating 2D video games. It is
13+
ideal for people learning to program, or developers that want to code a 2D
14+
game without learning a complex framework.
15+
1216
.. |Go| image:: images/woman_sprinter.svg
1317
:width: 48
1418
:alt: Start Here
@@ -33,13 +37,26 @@ The Python Arcade Library
3337
</tr>
3438
</table>
3539

40+
.. image:: images/example_games.svg
41+
:alt: Get Started icon
42+
:class: heading-icon
43+
44+
.. toctree::
45+
:maxdepth: 1
46+
:caption: Get Started
47+
48+
about/introduction
49+
programming_guide/get_started
50+
programming_guide/install/index
51+
programming_guide/how_to_get_help
52+
3653
.. image:: images/example_code.svg
3754
:alt: Example Code
3855
:class: heading-icon
3956

4057
.. toctree::
4158
:maxdepth: 1
42-
:caption: Example Code
59+
:caption: Examples
4360

4461
example_code/how_to_examples/index
4562
example_code/game_jam_2020
@@ -60,7 +77,6 @@ The Python Arcade Library
6077
tutorials/lights/index
6178
tutorials/bundling_with_pyinstaller/index
6279
tutorials/compiling_with_nuitka/index
63-
tutorials/framebuffer/index
6480
tutorials/shader_tutorials
6581
tutorials/menu/index
6682

@@ -70,34 +86,33 @@ The Python Arcade Library
7086

7187
.. toctree::
7288
:maxdepth: 1
73-
:caption: Programming Guide
89+
:caption: Guide
7490

75-
programming_guide/get_started
76-
programming_guide/install/index
7791
programming_guide/sprites/index
78-
programming_guide/how_to_get_help
92+
programming_guide/keyboard
93+
programming_guide/textures
94+
programming_guide/sections
95+
programming_guide/gui/index
96+
programming_guide/texture_atlas
7997
programming_guide/edge_artifacts/index
8098
programming_guide/logging
81-
programming_guide/pygame_comparison
99+
programming_guide/opengl_notes
100+
tutorials/framebuffer/index
101+
programming_guide/performance_tips
82102
programming_guide/headless
83103
programming_guide/vsync
84-
programming_guide/textures
85-
programming_guide/texture_atlas
86-
programming_guide/opengl_notes.rst
87-
programming_guide/gui/index
88-
programming_guide/performance_tips
89-
programming_guide/sections
104+
programming_guide/pygame_comparison
90105

91106
.. image:: images/API.svg
92107
:alt: API icon
93108
:class: heading-icon
94109

95110
.. toctree::
96111
:maxdepth: 1
97-
:caption: API Docs
112+
:caption: API
98113

99114
api_docs/api/quick_index
100-
api_docs/arcade
115+
Reference<api_docs/arcade>
101116
api_docs/resources
102117

103118
.. image:: images/source.svg
@@ -106,12 +121,25 @@ The Python Arcade Library
106121

107122
.. toctree::
108123
:maxdepth: 1
109-
:caption: Source Code & Contributing
124+
:caption: Source Code
110125

111126
GitHub <https://github.com/pythonarcade/arcade>
112127
programming_guide/release_notes
113128
License <https://github.com/pythonarcade/arcade/blob/development/license.rst>
129+
130+
.. image:: images/source.svg
131+
:alt: Source icon
132+
:class: heading-icon
133+
134+
.. toctree::
135+
:maxdepth: 1
136+
:caption: Contributing
137+
138+
contributing_guide/how_to_contribute
114139
contributing_guide/index
140+
contributing_guide/directory_structure
141+
contributing_guide/how_to_submit_changes
142+
contributing_guide/release_checklist
115143

116144
.. image:: images/social.svg
117145
:alt: Social icon
@@ -145,15 +173,3 @@ Learning Resources
145173
* `Aus PyCon 2018 Multiplayer Games <https://youtu.be/2SMkk63k6Ik>`_
146174
* `US PyCon 2018 Talk <https://youtu.be/DAWHMHMPVHU>`_
147175

148-
149-
.. raw:: html
150-
151-
<div style="padding:55% 0 0 0;position:relative;">
152-
<iframe class="vimeo-video" src="https://player.vimeo.com/video/662273899?h=31bf92c415&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen title="Arcade Demo.mp4"></iframe>
153-
</div><script src="https://player.vimeo.com/api/player.js"></script>
154-
<p><a href="https://vimeo.com/662273899">Quick Arcade Library Introduction Video</a></p>
155-
156-
Arcade is an easy-to-learn Python library for creating 2D video games. It is
157-
ideal for people learning to program, or developers that want to code a 2D
158-
game without learning a complex framework.
159-

doc/programming_guide/install/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Select the instructions for your platform:
1212
.. toctree::
1313
:maxdepth: 1
1414

15-
pycharm
1615
windows
1716
mac
1817
linux
1918
source
19+
pycharm
2020
obsolete
2121

File renamed without changes.

0 commit comments

Comments
 (0)