doc_stack/sidebar

doc/api_docs/arcade.rst

@@ -1,7 +1,7 @@
 .. _arcade-api:
 
-Arcade Package API
-==================
+API Reference
+=============
 
 This page documents the Application Programming Interface (API)
 for the Python Arcade library. See also:
@@ -35,7 +35,6 @@ for the Python Arcade library. See also:
  api/window
  api/sound
  api/path_finding
- api/version
  api/isometric
  api/earclip
  api/easing
@@ -47,7 +46,7 @@ for the Python Arcade library. See also:
 
 .. toctree::
  :maxdepth: 1
- :caption: Arcade GUI
+ :caption: GUI
 
  api/gui
  api/gui_widgets
@@ -57,16 +56,8 @@ for the Python Arcade library. See also:
 
 .. toctree::
  :maxdepth: 1
- :caption: Arcade Sub Modules
+ :caption: Constants
 
  arcade.key
  arcade.csscolor
  arcade.color
-
-.. toctree::
- :maxdepth: 1
- :caption: Other Information
-
- resources
- keyboard
-

doc/api_docs/gl/index.rst

@@ -1,7 +1,7 @@
 .. _arcade-api-gl:
 
-Arcade OpenGL API
-=================
+OpenGL
+======
 
 This is the low level rendering API in Arcade and is used
 internally for all drawing/rendering. It's a higher level

doc/contributing_guide/how_to_contribute.rst

@@ -1,7 +1,7 @@
 .. _how-to-contribute:
 
-How to Contribute
-=================
+Ways to Contribute
+==================
 
 We would love to have you contribute to the project! There are several
 ways that you can do so.

doc/contributing_guide/index.rst

@@ -2,20 +2,3 @@
 .. _cg_index_quickstart:
 
 .. include:: ../../CONTRIBUTING.rst
-
-.. _cg_index_contents:
-
-Contributing Guide Contents
----------------------------
-
-The sections linked below provide more in-depth coverage of various topics
-contributing to arcade, including links to outside resources on development tools
-and practices.
-
-.. toctree::
- :maxdepth: 1
-
- directory_structure
- how_to_contribute
- how_to_submit_changes
- release_checklist

doc/programming_guide/get_started.rst → doc/get_started/get_started.rst

@@ -1,7 +1,7 @@
 .. _get-started-here:
 
-Get Started Here
-================
+Start Here
+==========
 
 .. image:: images/treasure-map.svg
  :width: 40%
@@ -21,8 +21,8 @@ Getting Help
 If you get stuck, you can always ask for help! See the page on
 :ref:`how-to-get-help` for more information.
 
-Starting Tutorials
-------------------
+Tutorials
+---------
 
 If you are already familiar with basic Python programming, follow the
 :ref:`platformer_tutorial` as a quick way to get up and running.

doc/programming_guide/install/index.rst → doc/get_started/install/index.rst

@@ -1,7 +1,7 @@
 .. _installation-instructions:
 
-Installation Instructions
-=========================
+Installation
+============
 
 Arcade runs on Windows, Mac OS X, and Linux.
 
@@ -12,10 +12,10 @@ Select the instructions for your platform:
 .. toctree::
  :maxdepth: 1
 
- pycharm
  windows
  mac
  linux
  source
+ pycharm
  obsolete
 

doc/programming_guide/install/mac.rst → doc/get_started/install/mac.rst

@@ -1,5 +1,5 @@
-Installation on the Mac
-=======================
+Installation on Mac
+===================
 
 Go to the `Python website <https://www.python.org/downloads/>`_ and download Python.
 

doc/get_started/introduction.rst

@@ -0,0 +1,11 @@
+What is Arcade?
+===============
+
+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.
+
+.. raw:: html
+
+ <div style="padding:55% 0 0 0;position:relative;">
+ <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>
+ </div><script src="https://player.vimeo.com/api/player.js"></script>
+ <p><a href="https://vimeo.com/662273899">Quick Arcade Library Introduction Video</a></p>

doc/index.rst

@@ -9,9 +9,20 @@
 The Python Arcade Library
 =========================
 
+..
+ Wrapped in raw html to avoid repeating twice in the PDF, since this blurb is
+ repeated in `get_started/introduction.rst`
+.. raw:: html
+
+ <p>
+ 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.
+ </p>
+
 .. |Go| image:: images/woman_sprinter.svg
  :width: 48
- :alt: Get started here
+ :alt: Start Here
  :target: get_started.html
 
 .. raw:: html
@@ -21,8 +32,8 @@ The Python Arcade Library
  <td>
  <h2>
  <a class="reference internal" href="programming_guide/get_started.html">
- <img alt="Get started here" src="_images/woman_sprinter.svg" width="48">
- <span class="std std-ref">Get Started Here</span>
+ <img alt="Start Here" src="_images/woman_sprinter.svg" width="48">
+ <span class="std std-ref">Start Here</span>
  </a>
  <a class="headerlink" href="#go-get-started-here" title="Permalink to this headline">¶</a>
  </h2>
@@ -33,13 +44,26 @@ The Python Arcade Library
  </tr>
  </table>
 
+.. image:: images/example_games.svg
+ :alt: Get Started icon
+ :class: heading-icon
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Get Started
+
+ get_started/introduction
+ get_started/get_started
+ get_started/install/index
+ get_started/how_to_get_help
+
 .. image:: images/example_code.svg
  :alt: Example Code
  :class: heading-icon
 
 .. toctree::
  :maxdepth: 1
- :caption: Example Code
+ :caption: Examples
 
  example_code/how_to_examples/index
  example_code/game_jam_2020
@@ -60,46 +84,42 @@ The Python Arcade Library
  tutorials/lights/index
  tutorials/bundling_with_pyinstaller/index
  tutorials/compiling_with_nuitka/index
- tutorials/framebuffer/index
  tutorials/shader_tutorials
  tutorials/menu/index
+ tutorials/framebuffer/index
 
 .. image:: images/example_games.svg
  :alt: Programming guide icon
  :class: heading-icon
- :target: programming_guide
 
 .. toctree::
  :maxdepth: 1
- :caption: Programming Guide
+ :caption: Guide
 
- programming_guide/install/index
- programming_guide/get_started
  programming_guide/sprites/index
- programming_guide/how_to_get_help
+ programming_guide/keyboard
+ programming_guide/textures
+ programming_guide/sections
+ programming_guide/gui/index
+ programming_guide/texture_atlas
  programming_guide/edge_artifacts/index
  programming_guide/logging
- programming_guide/pygame_comparison
+ programming_guide/opengl_notes
+ programming_guide/performance_tips
  programming_guide/headless
  programming_guide/vsync
- programming_guide/textures
- programming_guide/texture_atlas
- programming_guide/opengl_notes.rst
- programming_guide/gui/index
- programming_guide/performance_tips
- programming_guide/sections
- programming_guide/index
+ programming_guide/pygame_comparison
 
 .. image:: images/API.svg
  :alt: API icon
  :class: heading-icon
 
 .. toctree::
  :maxdepth: 1
- :caption: API Docs
+ :caption: API
 
- api_docs/api/quick_index
- api_docs/arcade
+Index<api_docs/api/quick_index>
+Reference<api_docs/arcade>
  api_docs/resources
 
 .. image:: images/source.svg
@@ -108,14 +128,23 @@ The Python Arcade Library
 
 .. toctree::
  :maxdepth: 1
- :caption: Source Code & Contributing
+ :caption: Source Code
 
  GitHub <https://github.com/pythonarcade/arcade>
  programming_guide/release_notes
  License <https://github.com/pythonarcade/arcade/blob/development/license.rst>
+
+.. image:: images/source.svg
+ :alt: Source icon
+ :class: heading-icon
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Contributing
+
+ contributing_guide/how_to_contribute
  contributing_guide/index
  contributing_guide/directory_structure
- contributing_guide/how_to_contribute
  contributing_guide/how_to_submit_changes
  contributing_guide/release_checklist
 
@@ -151,15 +180,3 @@ Learning Resources
  * `Aus PyCon 2018 Multiplayer Games <https://youtu.be/2SMkk63k6Ik>`_
  * `US PyCon 2018 Talk <https://youtu.be/DAWHMHMPVHU>`_
 
-
-.. raw:: html
-
- <div style="padding:55% 0 0 0;position:relative;">
- <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>
- </div><script src="https://player.vimeo.com/api/player.js"></script>
- <p><a href="https://vimeo.com/662273899">Quick Arcade Library Introduction Video</a></p>
-
-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.
-

doc/api_docs/keyboard.rst → doc/programming_guide/keyboard.rst

@@ -1,5 +1,5 @@
-Working with the Keyboard
-=========================
+Keyboard
+========
 
 .. _keyboard_events:
 

doc/programming_guide/opengl_notes.rst

@@ -1,7 +1,7 @@
 .. _open_gl_notes:
 
-OpenGL Notes
-============
+OpenGL
+======
 
 Arcade is using OpenGL for the underlying rendering. OpenGL
 functionality is given to use through pyglet when a window

doc/programming_guide/performance_tips.rst

@@ -1,7 +1,7 @@
 .. _performance:
 
-Arcade Performance Information
-==============================
+Performance
+===========
 
 
 .. image:: ../images/flame-arrow.svg

doc/tutorials/card_game/index.rst

@@ -2,8 +2,8 @@
 
 .. _solitaire_tutorial:
 
-Solitaire Tutorial
-==================
+Solitaire
+=========
 
 .. image:: animated.gif
 

doc/tutorials/compute_shader/index.rst

@@ -1,7 +1,7 @@
 .. _compute_shader_tutorial:
 
-Compute Shader Tutorial
-=======================
+Compute Shader
+==============
 
 .. raw:: html