Skip to content

Commit 0e9e94e

Browse files
authored
Add Programming Guide index page (#1724)
* Add new Programming Guide index page to fix toctree issues * Add intro text to Programming Guide index page
1 parent a3c77a0 commit 0e9e94e

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

doc/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ The Python Arcade Library
6767
.. image:: images/example_games.svg
6868
:alt: Programming guide icon
6969
:class: heading-icon
70+
:target: programming_guide
7071

7172
.. toctree::
7273
:maxdepth: 1
@@ -91,6 +92,7 @@ The Python Arcade Library
9192
programming_guide/gui/index
9293
programming_guide/performance_tips
9394
programming_guide/sections
95+
programming_guide/index
9496

9597
.. image:: images/API.svg
9698
:alt: API icon

doc/programming_guide/index.rst

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _pg_index:
2+
3+
Arcade Programming Guide Index
4+
==============================
5+
6+
This section provides both instructions on getting started and overviews
7+
overviews of the following concepts:
8+
9+
* Arcade's overall structure
10+
* Basic drawing techniques & concepts
11+
* Avoiding common problems
12+
* General OpenGL notes
13+
* Advanced techniques & concepts
14+
15+
Pages may also include links to relevant examples, tutorials, or
16+
external documentation where applicable.
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
:caption: Programming Guide
21+
22+
install/index
23+
get_started
24+
how_to_get_help
25+
directory_structure
26+
edge_artifacts/index
27+
how_to_submit_changes
28+
how_to_contribute
29+
how_to_build
30+
logging
31+
release_checklist
32+
pygame_comparison
33+
headless
34+
vsync
35+
textures
36+
texture_atlas
37+
opengl_notes.rst
38+
gui/index
39+
performance_tips
40+
sections

0 commit comments

Comments
 (0)