From cfd413e263976bba8dec790c56d3ffd47b5dccf5 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Fri, 18 Oct 2024 08:45:19 -0400 Subject: [PATCH] contrib guide: populate the Code section There is a warning about a duplicate target, but it doesn't seem to cause issues in the built project. --- contrib/code/developer-workflow.rst | 25 +++++++++++++++++++++++++ contrib/code/development-tools.rst | 19 +++++++++++++++++++ contrib/code/git.rst | 11 +++++++++++ contrib/code/index.rst | 25 +++++++++++++++++-------- contrib/code/setup.rst | 12 ++++++++++++ contrib/code/testing.rst | 20 ++++++++++++++++++++ developer-workflow/index.rst | 2 ++ development-tools/index.rst | 2 ++ getting-started/index.rst | 2 ++ index.rst | 2 ++ testing/index.rst | 2 ++ 11 files changed, 114 insertions(+), 8 deletions(-) create mode 100644 contrib/code/developer-workflow.rst create mode 100644 contrib/code/development-tools.rst create mode 100644 contrib/code/git.rst create mode 100644 contrib/code/setup.rst create mode 100644 contrib/code/testing.rst diff --git a/contrib/code/developer-workflow.rst b/contrib/code/developer-workflow.rst new file mode 100644 index 0000000000..416ca2c022 --- /dev/null +++ b/contrib/code/developer-workflow.rst @@ -0,0 +1,25 @@ +==================== +Development workflow +==================== + +.. important:: + + |draft| + + |purpose| + +[This is the existing :ref:`dev-workflow` page from the devguide] + +.. toctree:: + :maxdepth: 5 + + ../../developer-workflow/communication-channels + ../../developer-workflow/development-cycle + ../../developer-workflow/stdlib + ../../developer-workflow/extension-modules + ../../developer-workflow/c-api + ../../developer-workflow/lang-changes + ../../developer-workflow/grammar + ../../developer-workflow/porting + ../../developer-workflow/sbom + ../../developer-workflow/psrt diff --git a/contrib/code/development-tools.rst b/contrib/code/development-tools.rst new file mode 100644 index 0000000000..348ceb95ac --- /dev/null +++ b/contrib/code/development-tools.rst @@ -0,0 +1,19 @@ +================= +Development tools +================= + +.. important:: + + |draft| + + |purpose| + +[This is the existing :ref:`development-tools` page from the devguide.] + +.. toctree:: + :maxdepth: 5 + + ../../development-tools/clinic + ../../development-tools/gdb + ../../development-tools/clang + ../../development-tools/warnings diff --git a/contrib/code/git.rst b/contrib/code/git.rst new file mode 100644 index 0000000000..7c7aaa57b1 --- /dev/null +++ b/contrib/code/git.rst @@ -0,0 +1,11 @@ +======== +Git tips +======== + +.. important:: + + |draft| + + |purpose| + +[More git help for advanced things needed by code contributors.] diff --git a/contrib/code/index.rst b/contrib/code/index.rst index e7969406fa..4839d1bf01 100644 --- a/contrib/code/index.rst +++ b/contrib/code/index.rst @@ -8,11 +8,20 @@ Code contributions |purpose| -* Code setup and building (more complex stuff, delta from basic setup above) -* More Git bootcamp (pull requests, etc) -* Lifecycle of a code pull request -* Development workflow (from devguide) -* Testing and buildbots (from devguide) -* Development tools (from devguide) -* CPython’s internals (from devguide) -* Code style guide +[The main page for code contributors.] + +[We'll include code-focused content from the :ref:`main devguide page `: Quick +reference, Quick links, Proposing changes, and so on.] + +[The existing "CPython's internals" section of the devguide will be fully +migrated into the Python repo.] + + +.. toctree:: + :maxdepth: 5 + + setup + git + developer-workflow + testing + development-tools diff --git a/contrib/code/setup.rst b/contrib/code/setup.rst new file mode 100644 index 0000000000..096f2f5691 --- /dev/null +++ b/contrib/code/setup.rst @@ -0,0 +1,12 @@ +================== +Setup and Building +================== + +.. important:: + + |draft| + + |purpose| + +[More setup and build instructions specifically for code contributors, building +on the basics from the :ref:`Getting Started ` section.] diff --git a/contrib/code/testing.rst b/contrib/code/testing.rst new file mode 100644 index 0000000000..575d1477a4 --- /dev/null +++ b/contrib/code/testing.rst @@ -0,0 +1,20 @@ +===================== +Testing and buildbots +===================== + +.. important:: + + |draft| + + |purpose| + +[This is the existing :ref:`testing` page from the devguide.] + +.. toctree:: + :maxdepth: 5 + + ../../testing/run-write-tests + ../../testing/silence-warnings + ../../testing/coverage + ../../testing/buildbots + ../../testing/new-buildbot-worker diff --git a/developer-workflow/index.rst b/developer-workflow/index.rst index ca39a72756..e73927f1dd 100644 --- a/developer-workflow/index.rst +++ b/developer-workflow/index.rst @@ -1,3 +1,5 @@ +.. _dev-workflow: + ==================== Development workflow ==================== diff --git a/development-tools/index.rst b/development-tools/index.rst index 610d8d8ea8..5031227a18 100644 --- a/development-tools/index.rst +++ b/development-tools/index.rst @@ -1,3 +1,5 @@ +.. _development-tools: + ================= Development tools ================= diff --git a/getting-started/index.rst b/getting-started/index.rst index 18f7d5cd55..61eb1d9ab1 100644 --- a/getting-started/index.rst +++ b/getting-started/index.rst @@ -1,3 +1,5 @@ +.. _getting-started: + =============== Getting started =============== diff --git a/index.rst b/index.rst index ec07d41f98..9dbc06908b 100644 --- a/index.rst +++ b/index.rst @@ -1,3 +1,5 @@ +.. _devguide-main: + ======================== Python Developer's Guide ======================== diff --git a/testing/index.rst b/testing/index.rst index 770c258000..55bdd3d08b 100644 --- a/testing/index.rst +++ b/testing/index.rst @@ -1,3 +1,5 @@ +.. _testing: + ===================== Testing and buildbots =====================