Skip to content

Add Programming Guide index page #1724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The Python Arcade Library
.. image:: images/example_games.svg
:alt: Programming guide icon
:class: heading-icon
:target: programming_guide

.. toctree::
:maxdepth: 1
Expand All @@ -91,6 +92,7 @@ The Python Arcade Library
programming_guide/gui/index
programming_guide/performance_tips
programming_guide/sections
programming_guide/index

.. image:: images/API.svg
:alt: API icon
Expand Down
40 changes: 40 additions & 0 deletions doc/programming_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _pg_index:

Arcade Programming Guide Index
==============================

This section provides both instructions on getting started and overviews
overviews of the following concepts:

* Arcade's overall structure
* Basic drawing techniques & concepts
* Avoiding common problems
* General OpenGL notes
* Advanced techniques & concepts

Pages may also include links to relevant examples, tutorials, or
external documentation where applicable.

.. toctree::
:maxdepth: 1
:caption: Programming Guide

install/index
get_started
how_to_get_help
directory_structure
edge_artifacts/index
how_to_submit_changes
how_to_contribute
how_to_build
logging
release_checklist
pygame_comparison
headless
vsync
textures
texture_atlas
opengl_notes.rst
gui/index
performance_tips
sections