contrib guide: populate the Code section (#1450)

nedbat · hugovk · web-flow · commit d20061fa0b61 · 2024-10-19T07:17:12.000-04:00
There is a warning about a duplicate target, but it doesn't seem to
cause issues in the built project.

Co-authored-by: Hugo van Kemenade &lt;1324225+hugovk@users.noreply.github.com&gt;
diff --git a/contrib/code/developer-workflow.rst 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
@@ -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
@@ -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
@@ -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 <devguide-main>`: 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
@@ -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 <getting-started>` section.]
diff --git a/contrib/code/testing.rst 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
@@ -1,3 +1,5 @@
+.. _dev-workflow:
+
 ====================
 Development workflow
 ====================
diff --git 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
@@ -1,3 +1,5 @@
+.. _getting-started:
+
 ===============
 Getting started
 ===============
diff --git 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
@@ -1,3 +1,5 @@
+.. _testing:
+
 =====================
 Testing and buildbots
 =====================

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _dev-workflow:`
	`2`	`+`
`1`	`3`	`====================`
`2`	`4`	`Development workflow`
`3`	`5`	`====================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _development-tools:`
	`2`	`+`
`1`	`3`	`=================`
`2`	`4`	`Development tools`
`3`	`5`	`=================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _getting-started:`
	`2`	`+`
`1`	`3`	`===============`
`2`	`4`	`Getting started`
`3`	`5`	`===============`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _devguide-main:`
	`2`	`+`
`1`	`3`	`========================`
`2`	`4`	`Python Developer's Guide`
`3`	`5`	`========================`