diff --git a/doc/api_docs/arcade.rst b/doc/api_docs/arcade.rst index 85a8c119d..3ce4a8567 100644 --- a/doc/api_docs/arcade.rst +++ b/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 - diff --git a/doc/api_docs/gl/index.rst b/doc/api_docs/gl/index.rst index 59d73c537..b4e95113e 100644 --- a/doc/api_docs/gl/index.rst +++ b/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 diff --git a/doc/contributing_guide/how_to_contribute.rst b/doc/contributing_guide/how_to_contribute.rst index a76501b65..59ede58b8 100644 --- a/doc/contributing_guide/how_to_contribute.rst +++ b/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. diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index e9b76d5e4..5c9a941bf 100644 --- a/doc/contributing_guide/index.rst +++ b/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 diff --git a/doc/programming_guide/get_started.rst b/doc/get_started/get_started.rst similarity index 98% rename from doc/programming_guide/get_started.rst rename to doc/get_started/get_started.rst index 034d4daef..ba0558876 100644 --- a/doc/programming_guide/get_started.rst +++ b/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. diff --git a/doc/programming_guide/how_to_get_help.rst b/doc/get_started/how_to_get_help.rst similarity index 100% rename from doc/programming_guide/how_to_get_help.rst rename to doc/get_started/how_to_get_help.rst diff --git a/doc/programming_guide/images/discord_code_entry_desktop.png b/doc/get_started/images/discord_code_entry_desktop.png similarity index 100% rename from doc/programming_guide/images/discord_code_entry_desktop.png rename to doc/get_started/images/discord_code_entry_desktop.png diff --git a/doc/programming_guide/images/discord_help_channels.png b/doc/get_started/images/discord_help_channels.png similarity index 100% rename from doc/programming_guide/images/discord_help_channels.png rename to doc/get_started/images/discord_help_channels.png diff --git a/doc/programming_guide/images/discord_help_example.png b/doc/get_started/images/discord_help_example.png similarity index 100% rename from doc/programming_guide/images/discord_help_example.png rename to doc/get_started/images/discord_help_example.png diff --git a/doc/programming_guide/images/treasure-map.svg b/doc/get_started/images/treasure-map.svg similarity index 100% rename from doc/programming_guide/images/treasure-map.svg rename to doc/get_started/images/treasure-map.svg diff --git a/doc/programming_guide/images/tree.svg b/doc/get_started/images/tree.svg similarity index 100% rename from doc/programming_guide/images/tree.svg rename to doc/get_started/images/tree.svg diff --git a/doc/programming_guide/install/images/click_gear.png b/doc/get_started/install/images/click_gear.png similarity index 100% rename from doc/programming_guide/install/images/click_gear.png rename to doc/get_started/install/images/click_gear.png diff --git a/doc/programming_guide/install/images/file_settings.png b/doc/get_started/install/images/file_settings.png similarity index 100% rename from doc/programming_guide/install/images/file_settings.png rename to doc/get_started/install/images/file_settings.png diff --git a/doc/programming_guide/install/images/mac1.png b/doc/get_started/install/images/mac1.png similarity index 100% rename from doc/programming_guide/install/images/mac1.png rename to doc/get_started/install/images/mac1.png diff --git a/doc/programming_guide/install/images/mac2.png b/doc/get_started/install/images/mac2.png similarity index 100% rename from doc/programming_guide/install/images/mac2.png rename to doc/get_started/install/images/mac2.png diff --git a/doc/programming_guide/install/images/mac3.png b/doc/get_started/install/images/mac3.png similarity index 100% rename from doc/programming_guide/install/images/mac3.png rename to doc/get_started/install/images/mac3.png diff --git a/doc/programming_guide/install/images/mac4.png b/doc/get_started/install/images/mac4.png similarity index 100% rename from doc/programming_guide/install/images/mac4.png rename to doc/get_started/install/images/mac4.png diff --git a/doc/programming_guide/install/images/mac5.png b/doc/get_started/install/images/mac5.png similarity index 100% rename from doc/programming_guide/install/images/mac5.png rename to doc/get_started/install/images/mac5.png diff --git a/doc/programming_guide/install/images/mac6.png b/doc/get_started/install/images/mac6.png similarity index 100% rename from doc/programming_guide/install/images/mac6.png rename to doc/get_started/install/images/mac6.png diff --git a/doc/programming_guide/install/images/name_venv.png b/doc/get_started/install/images/name_venv.png similarity index 100% rename from doc/programming_guide/install/images/name_venv.png rename to doc/get_started/install/images/name_venv.png diff --git a/doc/programming_guide/install/images/pip_install_arcade_windows.png b/doc/get_started/install/images/pip_install_arcade_windows.png similarity index 100% rename from doc/programming_guide/install/images/pip_install_arcade_windows.png rename to doc/get_started/install/images/pip_install_arcade_windows.png diff --git a/doc/programming_guide/install/images/pycharm_mac_select_python.png b/doc/get_started/install/images/pycharm_mac_select_python.png similarity index 100% rename from doc/programming_guide/install/images/pycharm_mac_select_python.png rename to doc/get_started/install/images/pycharm_mac_select_python.png diff --git a/doc/programming_guide/install/images/requirements.png b/doc/get_started/install/images/requirements.png similarity index 100% rename from doc/programming_guide/install/images/requirements.png rename to doc/get_started/install/images/requirements.png diff --git a/doc/programming_guide/install/images/setup_windows_1.png b/doc/get_started/install/images/setup_windows_1.png similarity index 100% rename from doc/programming_guide/install/images/setup_windows_1.png rename to doc/get_started/install/images/setup_windows_1.png diff --git a/doc/programming_guide/install/images/setup_windows_2.png b/doc/get_started/install/images/setup_windows_2.png similarity index 100% rename from doc/programming_guide/install/images/setup_windows_2.png rename to doc/get_started/install/images/setup_windows_2.png diff --git a/doc/programming_guide/install/images/setup_windows_3.png b/doc/get_started/install/images/setup_windows_3.png similarity index 100% rename from doc/programming_guide/install/images/setup_windows_3.png rename to doc/get_started/install/images/setup_windows_3.png diff --git a/doc/programming_guide/install/images/setup_windows_4.png b/doc/get_started/install/images/setup_windows_4.png similarity index 100% rename from doc/programming_guide/install/images/setup_windows_4.png rename to doc/get_started/install/images/setup_windows_4.png diff --git a/doc/programming_guide/install/images/setup_windows_5.png b/doc/get_started/install/images/setup_windows_5.png similarity index 100% rename from doc/programming_guide/install/images/setup_windows_5.png rename to doc/get_started/install/images/setup_windows_5.png diff --git a/doc/programming_guide/install/images/venv_setup_1.png b/doc/get_started/install/images/venv_setup_1.png similarity index 100% rename from doc/programming_guide/install/images/venv_setup_1.png rename to doc/get_started/install/images/venv_setup_1.png diff --git a/doc/programming_guide/install/images/venv_setup_2.png b/doc/get_started/install/images/venv_setup_2.png similarity index 100% rename from doc/programming_guide/install/images/venv_setup_2.png rename to doc/get_started/install/images/venv_setup_2.png diff --git a/doc/programming_guide/install/images/venv_setup_3.png b/doc/get_started/install/images/venv_setup_3.png similarity index 100% rename from doc/programming_guide/install/images/venv_setup_3.png rename to doc/get_started/install/images/venv_setup_3.png diff --git a/doc/programming_guide/install/images/venv_setup_4.png b/doc/get_started/install/images/venv_setup_4.png similarity index 100% rename from doc/programming_guide/install/images/venv_setup_4.png rename to doc/get_started/install/images/venv_setup_4.png diff --git a/doc/programming_guide/install/index.rst b/doc/get_started/install/index.rst similarity index 84% rename from doc/programming_guide/install/index.rst rename to doc/get_started/install/index.rst index 4e489ffb7..0f62152c4 100644 --- a/doc/programming_guide/install/index.rst +++ b/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 diff --git a/doc/programming_guide/install/linux.rst b/doc/get_started/install/linux.rst similarity index 100% rename from doc/programming_guide/install/linux.rst rename to doc/get_started/install/linux.rst diff --git a/doc/programming_guide/install/mac.rst b/doc/get_started/install/mac.rst similarity index 96% rename from doc/programming_guide/install/mac.rst rename to doc/get_started/install/mac.rst index 83951ea1c..f6e964c6e 100644 --- a/doc/programming_guide/install/mac.rst +++ b/doc/get_started/install/mac.rst @@ -1,5 +1,5 @@ -Installation on the Mac -======================= +Installation on Mac +=================== Go to the `Python website `_ and download Python. diff --git a/doc/programming_guide/install/obsolete.rst b/doc/get_started/install/obsolete.rst similarity index 100% rename from doc/programming_guide/install/obsolete.rst rename to doc/get_started/install/obsolete.rst diff --git a/doc/programming_guide/install/pycharm.rst b/doc/get_started/install/pycharm.rst similarity index 100% rename from doc/programming_guide/install/pycharm.rst rename to doc/get_started/install/pycharm.rst diff --git a/doc/programming_guide/install/source.rst b/doc/get_started/install/source.rst similarity index 100% rename from doc/programming_guide/install/source.rst rename to doc/get_started/install/source.rst diff --git a/doc/programming_guide/install/windows.rst b/doc/get_started/install/windows.rst similarity index 100% rename from doc/programming_guide/install/windows.rst rename to doc/get_started/install/windows.rst diff --git a/doc/get_started/introduction.rst b/doc/get_started/introduction.rst new file mode 100644 index 000000000..86daf41b5 --- /dev/null +++ b/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 + +
+ +
+

Quick Arcade Library Introduction Video

\ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 5ddf32ab1..b6280d0d3 100644 --- a/doc/index.rst +++ b/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 + +

+ 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. +

+ .. |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

- Get started here - Get Started Here + Start Here + Start Here ΒΆ

@@ -33,13 +44,26 @@ The Python Arcade Library +.. 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,35 +84,31 @@ 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 @@ -96,10 +116,10 @@ The Python Arcade Library .. toctree:: :maxdepth: 1 - :caption: API Docs + :caption: API - api_docs/api/quick_index - api_docs/arcade + Index + Reference 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 programming_guide/release_notes License + +.. 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 `_ * `US PyCon 2018 Talk `_ - -.. raw:: html - -
- -
-

Quick Arcade Library Introduction Video

- -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. - diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst deleted file mode 100644 index 0a6f04b6e..000000000 --- a/doc/programming_guide/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _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 - sprites/index - how_to_get_help - edge_artifacts/index - logging - pygame_comparison - headless - vsync - textures - texture_atlas - opengl_notes.rst - gui/index - performance_tips - sections diff --git a/doc/api_docs/keyboard.rst b/doc/programming_guide/keyboard.rst similarity index 98% rename from doc/api_docs/keyboard.rst rename to doc/programming_guide/keyboard.rst index e90719798..d09a3a729 100644 --- a/doc/api_docs/keyboard.rst +++ b/doc/programming_guide/keyboard.rst @@ -1,5 +1,5 @@ -Working with the Keyboard -========================= +Keyboard +======== .. _keyboard_events: diff --git a/doc/programming_guide/opengl_notes.rst b/doc/programming_guide/opengl_notes.rst index e10ad54cc..d179fa81e 100644 --- a/doc/programming_guide/opengl_notes.rst +++ b/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 diff --git a/doc/programming_guide/performance_tips.rst b/doc/programming_guide/performance_tips.rst index 66c110dee..2d77d6fe9 100644 --- a/doc/programming_guide/performance_tips.rst +++ b/doc/programming_guide/performance_tips.rst @@ -1,7 +1,7 @@ .. _performance: -Arcade Performance Information -============================== +Performance +=========== .. image:: ../images/flame-arrow.svg diff --git a/doc/tutorials/card_game/index.rst b/doc/tutorials/card_game/index.rst index d6e7497f0..5cc666cd4 100644 --- a/doc/tutorials/card_game/index.rst +++ b/doc/tutorials/card_game/index.rst @@ -2,8 +2,8 @@ .. _solitaire_tutorial: -Solitaire Tutorial -================== +Solitaire +========= .. image:: animated.gif diff --git a/doc/tutorials/compute_shader/index.rst b/doc/tutorials/compute_shader/index.rst index 58b96bfad..92931ba16 100644 --- a/doc/tutorials/compute_shader/index.rst +++ b/doc/tutorials/compute_shader/index.rst @@ -1,7 +1,7 @@ .. _compute_shader_tutorial: -Compute Shader Tutorial -======================= +Compute Shader +============== .. raw:: html diff --git a/doc/tutorials/lights/index.rst b/doc/tutorials/lights/index.rst index ae7997606..6ae59faac 100644 --- a/doc/tutorials/lights/index.rst +++ b/doc/tutorials/lights/index.rst @@ -1,7 +1,7 @@ .. _light_tutorial: -Lights Tutorial -=============== +Lights +====== .. image:: lights.png diff --git a/doc/tutorials/shader_toy_glow/index.rst b/doc/tutorials/shader_toy_glow/index.rst index 735342cf9..baa5fc402 100644 --- a/doc/tutorials/shader_toy_glow/index.rst +++ b/doc/tutorials/shader_toy_glow/index.rst @@ -1,7 +1,7 @@ .. _shader_toy_tutorial_glow: -Shader Toy Tutorial - Glow -========================== +Shader Toy - Glow +================= .. figure:: cyber_fuji_2020.png :width: 60% diff --git a/doc/tutorials/shader_toy_particles/index.rst b/doc/tutorials/shader_toy_particles/index.rst index 1ffb2c6f1..52e096e58 100644 --- a/doc/tutorials/shader_toy_particles/index.rst +++ b/doc/tutorials/shader_toy_particles/index.rst @@ -1,7 +1,7 @@ .. _shader_toy_tutorial_particles: -Shader Toy Tutorial - Particles -=============================== +Shader Toy - Particles +====================== .. contents:: diff --git a/doc/tutorials/shader_tutorials.rst b/doc/tutorials/shader_tutorials.rst index f5a945e58..04564e561 100644 --- a/doc/tutorials/shader_tutorials.rst +++ b/doc/tutorials/shader_tutorials.rst @@ -1,5 +1,5 @@ -Shader Tutorials -================ +Shaders +======= .. _tutorials_shaders: diff --git a/util/template_quick_index.rst b/util/template_quick_index.rst index ef1f59e7b..2f440e0f5 100644 --- a/util/template_quick_index.rst +++ b/util/template_quick_index.rst @@ -19,8 +19,8 @@ .. _quick_index: -Quick API Index -=============== +API Index +========= * :ref:`color` * :ref:`csscolor` diff --git a/util/update_quick_index.py b/util/update_quick_index.py index 610afd61b..b0b914fd9 100644 --- a/util/update_quick_index.py +++ b/util/update_quick_index.py @@ -58,7 +58,6 @@ '__init__.py': ['Misc Utility Functions', 'utility.rst'], '__main__.py': ['Misc Utility Functions', 'utility.rst'], 'utils.py': ['Misc Utility Functions', 'utility.rst'], - 'version.py': ['Arcade Version Number', 'version.rst'], 'window_commands.py': ['Window and View', 'window.rst'], 'sections.py': ['Window and View', 'window.rst'], 'texture_atlas/__init__.py': ['Texture Atlas', 'texture_atlas.rst'], @@ -102,6 +101,9 @@ 'gl/texture.py': ['Texture Management', 'open_gl.rst'], 'gl/vertex_array.py': ['OpenGL Vertex Array (VAO)', 'open_gl.rst'], } +excluded_modules = [ + 'version.py' +] # Module and class members to exclude EXCLUDED_MEMBERS = [ @@ -211,7 +213,7 @@ def process_directory(directory: Path, quick_index_file): if path_name in titles and (len(type_list) > 0 or len(class_list) > 0 or len(function_list) > 0): title = titles[path_name][0] api_file_name = titles[path_name][1] - elif path_name not in titles: + elif path_name not in titles and path_name not in excluded_modules: title = f"ERR: `{path_name}`" api_file_name = "zzz.rst" print(f"No title for '{path_name}'.")