From 67b942000330e7f2c1598db8b3b815e4076ced48 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Thu, 4 May 2023 01:32:19 -0400 Subject: [PATCH 01/10] Add contributing guide index page & link it in toctree --- doc/contributing_guide/index.rst | 8 ++++++++ doc/index.rst | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 doc/contributing_guide/index.rst diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst new file mode 100644 index 000000000..7d6073c67 --- /dev/null +++ b/doc/contributing_guide/index.rst @@ -0,0 +1,8 @@ +.. _cg_index: + +Arcade Contributing Guide +========================= + +This section is for people who want to make contributions or propose +changes to Arcade itself. For a quick overview, please see +`CONTRIBUTING.md `_. diff --git a/doc/index.rst b/doc/index.rst index 83941285a..dd57d9f1b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -113,8 +113,9 @@ The Python Arcade Library .. toctree:: :maxdepth: 1 - :caption: Source Code + :caption: Source Code & Contributing + contributing_guide/index GitHub programming_guide/release_notes License From 4134c8df57e55e88ce0f452abde2c688e7f16841 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 10:34:13 -0400 Subject: [PATCH 02/10] Flesh out the Contributing Guide index page --- doc/contributing_guide/index.rst | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index 7d6073c67..e1463ae9a 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -3,6 +3,29 @@ Arcade Contributing Guide ========================= -This section is for people who want to make contributions or propose -changes to Arcade itself. For a quick overview, please see -`CONTRIBUTING.md `_. +The contributing guide is for people who want to propose changes, +implement features, or report bugs in Arcade itself. + +For information on how to use arcade to build your own projects, please see +:ref:`pg_index`. + + +.. _cg_index_quickstart: + +Contributing Quickstart +^^^^^^^^^^^^^^^^^^^^^^^ +For a quick overview, please see +`CONTRIBUTING.md on GitHub `_. + + +.. _cg_index_contents: + +Contributing Guide Contents +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The sections linked below will provide more in-depth coverage of various topics +contributing to arcade, including links to outside resources on development tools +and practices. + +.. toctree:: + :maxdepth: 1 From ed1741a05184a49dd926c3ed9608677cbb265bd6 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 14:32:05 -0400 Subject: [PATCH 03/10] Move Directory Structure page into Contributing Guide --- .../directory_structure.rst | 2 +- doc/contributing_guide/index.rst | 2 ++ doc/index.rst | 2 +- doc/programming_guide/index.rst | 1 - 4 files changed, 4 insertions(+), 3 deletions(-) rename doc/{programming_guide => contributing_guide}/directory_structure.rst (99%) diff --git a/doc/programming_guide/directory_structure.rst b/doc/contributing_guide/directory_structure.rst similarity index 99% rename from doc/programming_guide/directory_structure.rst rename to doc/contributing_guide/directory_structure.rst index dbec906ee..6b6744934 100644 --- a/doc/programming_guide/directory_structure.rst +++ b/doc/contributing_guide/directory_structure.rst @@ -1,4 +1,4 @@ -.. _directory-structure: +.. _directory_structure: Directory Structure =================== diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index e1463ae9a..0cc33ec27 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -29,3 +29,5 @@ and practices. .. toctree:: :maxdepth: 1 + + directory_structure \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index dd57d9f1b..2cdbeddf0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -77,7 +77,6 @@ The Python Arcade Library programming_guide/get_started programming_guide/sprites/index programming_guide/how_to_get_help - programming_guide/directory_structure programming_guide/edge_artifacts/index programming_guide/how_to_submit_changes programming_guide/how_to_contribute @@ -116,6 +115,7 @@ The Python Arcade Library :caption: Source Code & Contributing contributing_guide/index + contributing_guide/directory_structure GitHub programming_guide/release_notes License diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst index 694c9b727..ac755518e 100644 --- a/doc/programming_guide/index.rst +++ b/doc/programming_guide/index.rst @@ -23,7 +23,6 @@ external documentation where applicable. get_started sprites/index how_to_get_help - directory_structure edge_artifacts/index how_to_submit_changes how_to_contribute From 3ed430a338c5e53c9b1f6256f31fc3d07d9ff9ce Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 14:36:25 -0400 Subject: [PATCH 04/10] Move how to submit changes into Contributing Guide --- .../how_to_submit_changes.rst | 0 doc/contributing_guide/index.rst | 3 ++- doc/index.rst | 2 +- doc/programming_guide/index.rst | 1 - 4 files changed, 3 insertions(+), 3 deletions(-) rename doc/{programming_guide => contributing_guide}/how_to_submit_changes.rst (100%) diff --git a/doc/programming_guide/how_to_submit_changes.rst b/doc/contributing_guide/how_to_submit_changes.rst similarity index 100% rename from doc/programming_guide/how_to_submit_changes.rst rename to doc/contributing_guide/how_to_submit_changes.rst diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index 0cc33ec27..373b08542 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -30,4 +30,5 @@ and practices. .. toctree:: :maxdepth: 1 - directory_structure \ No newline at end of file + directory_structure + how_to_submit_changes diff --git a/doc/index.rst b/doc/index.rst index 2cdbeddf0..3f3acc228 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -78,7 +78,6 @@ The Python Arcade Library programming_guide/sprites/index programming_guide/how_to_get_help programming_guide/edge_artifacts/index - programming_guide/how_to_submit_changes programming_guide/how_to_contribute programming_guide/how_to_build programming_guide/logging @@ -116,6 +115,7 @@ The Python Arcade Library contributing_guide/index contributing_guide/directory_structure + contributing_guide/how_to_submit_changes GitHub programming_guide/release_notes License diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst index ac755518e..dd91e35b5 100644 --- a/doc/programming_guide/index.rst +++ b/doc/programming_guide/index.rst @@ -24,7 +24,6 @@ external documentation where applicable. sprites/index how_to_get_help edge_artifacts/index - how_to_submit_changes how_to_contribute how_to_build logging From 2f9af464b4ea042902a750236364d415e974a9b7 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 14:46:24 -0400 Subject: [PATCH 05/10] Move Build & Contribution instructions to Contributing Guide --- .../how_to_build.rst | 0 .../how_to_contribute.rst | 0 doc/contributing_guide/index.rst | 2 ++ doc/index.rst | 4 ++-- doc/programming_guide/index.rst | 2 -- 5 files changed, 4 insertions(+), 4 deletions(-) rename doc/{programming_guide => contributing_guide}/how_to_build.rst (100%) rename doc/{programming_guide => contributing_guide}/how_to_contribute.rst (100%) diff --git a/doc/programming_guide/how_to_build.rst b/doc/contributing_guide/how_to_build.rst similarity index 100% rename from doc/programming_guide/how_to_build.rst rename to doc/contributing_guide/how_to_build.rst diff --git a/doc/programming_guide/how_to_contribute.rst b/doc/contributing_guide/how_to_contribute.rst similarity index 100% rename from doc/programming_guide/how_to_contribute.rst rename to doc/contributing_guide/how_to_contribute.rst diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index 373b08542..964326e92 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -31,4 +31,6 @@ and practices. :maxdepth: 1 directory_structure + how_to_contribute + how_to_build how_to_submit_changes diff --git a/doc/index.rst b/doc/index.rst index 3f3acc228..3a3942332 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -78,8 +78,6 @@ The Python Arcade Library programming_guide/sprites/index programming_guide/how_to_get_help programming_guide/edge_artifacts/index - programming_guide/how_to_contribute - programming_guide/how_to_build programming_guide/logging programming_guide/release_checklist programming_guide/pygame_comparison @@ -115,6 +113,8 @@ The Python Arcade Library contributing_guide/index contributing_guide/directory_structure + contributing_guide/how_to_contribute + contributing_guide/how_to_build contributing_guide/how_to_submit_changes GitHub programming_guide/release_notes diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst index dd91e35b5..2e0e4ef52 100644 --- a/doc/programming_guide/index.rst +++ b/doc/programming_guide/index.rst @@ -24,8 +24,6 @@ external documentation where applicable. sprites/index how_to_get_help edge_artifacts/index - how_to_contribute - how_to_build logging release_checklist pygame_comparison From 8d71dca2adac77cb49d732abcb69210b2a78a2f9 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 15:07:48 -0400 Subject: [PATCH 06/10] Move Release Checklist into Contributing guide --- doc/contributing_guide/index.rst | 1 + .../release_checklist.rst | 0 doc/programming_guide/index.rst | 1 - 3 files changed, 1 insertion(+), 1 deletion(-) rename doc/{programming_guide => contributing_guide}/release_checklist.rst (100%) diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index 964326e92..798509a74 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -34,3 +34,4 @@ and practices. how_to_contribute how_to_build how_to_submit_changes + release_checklist diff --git a/doc/programming_guide/release_checklist.rst b/doc/contributing_guide/release_checklist.rst similarity index 100% rename from doc/programming_guide/release_checklist.rst rename to doc/contributing_guide/release_checklist.rst diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst index 2e0e4ef52..0a6f04b6e 100644 --- a/doc/programming_guide/index.rst +++ b/doc/programming_guide/index.rst @@ -25,7 +25,6 @@ external documentation where applicable. how_to_get_help edge_artifacts/index logging - release_checklist pygame_comparison headless vsync From dca3edeef0b5227787f30c87218a1ecf6aff7b56 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 15:12:49 -0400 Subject: [PATCH 07/10] Move release checklist on the landing page --- doc/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 3a3942332..a819b1f7d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -79,7 +79,6 @@ The Python Arcade Library programming_guide/how_to_get_help programming_guide/edge_artifacts/index programming_guide/logging - programming_guide/release_checklist programming_guide/pygame_comparison programming_guide/headless programming_guide/vsync From 5a8fc34f92848ee416035d0ae582455ccb662d3a Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 15:24:16 -0400 Subject: [PATCH 08/10] Revert change in label name to make this PR a pure move --- doc/contributing_guide/directory_structure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing_guide/directory_structure.rst b/doc/contributing_guide/directory_structure.rst index 6b6744934..dbec906ee 100644 --- a/doc/contributing_guide/directory_structure.rst +++ b/doc/contributing_guide/directory_structure.rst @@ -1,4 +1,4 @@ -.. _directory_structure: +.. _directory-structure: Directory Structure =================== From 68bc286b94241531e7082ce290625076c84dfe72 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 15:46:26 -0400 Subject: [PATCH 09/10] Add release checklist to Source Code & Contributing section on the landing page --- doc/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/index.rst b/doc/index.rst index a819b1f7d..7a2b19b66 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -115,6 +115,7 @@ The Python Arcade Library contributing_guide/how_to_contribute contributing_guide/how_to_build contributing_guide/how_to_submit_changes + contributing_guide/release_checklist GitHub programming_guide/release_notes License From ee1086e69be9e8bff1ab56fd5616bfe005ed0363 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 15:48:35 -0400 Subject: [PATCH 10/10] Reorder source section to put GitHub first on the top left --- doc/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 7a2b19b66..beaad665f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -110,15 +110,15 @@ The Python Arcade Library :maxdepth: 1 :caption: Source Code & Contributing + GitHub + programming_guide/release_notes + License contributing_guide/index contributing_guide/directory_structure contributing_guide/how_to_contribute contributing_guide/how_to_build contributing_guide/how_to_submit_changes contributing_guide/release_checklist - GitHub - programming_guide/release_notes - License .. image:: images/social.svg :alt: Social icon