Split out contributing to the devguide

Author: AA-Turner

documentation/devguide.rst

@@ -0,0 +1,54 @@
+.. _devguide:
+
+==================================
+Helping with the Developer's Guide
+==================================
+
+.. highlight:: console
+
+The Developer's Guide (what you're reading now) uses the same process as the
+main Python documentation, except for some small differences.  The source
+lives in a `separate repository`_ and bug reports should be submitted to the
+`devguide GitHub tracker`_.
+
+Our devguide workflow uses continuous integration and deployment so changes to
+the devguide are normally published when the pull request is merged. Changes
+to CPython documentation follow the workflow of a CPython release and are
+published in the release.
+
+
+Developer's Guide workflow
+==========================
+
+To submit a :ref:`pull request <pullrequest>`, you can fork the
+`devguide repo`_ to your GitHub account and clone it using::
+
+    $ git clone https://github.com/<your_username>/devguide
+
+For your PR to be accepted, you will also need to sign the
+:ref:`contributor agreement <cla>`.
+
+To build the devguide, some additional dependencies are required (most
+importantly, `Sphinx`_), and the standard way to install dependencies in
+Python projects is to create a virtualenv, and then install dependencies from
+a ``requirements.txt`` file. For your convenience, this is all *automated for
+you*. To build the devguide on a Unix-like system use::
+
+   $ make html
+
+in the checkout directory.  On Windows use:
+
+.. code-block:: doscon
+
+   > .\make html
+
+You will find the generated files in ``_build/html`` or, if you use
+``make htmlview``, the docs will be opened in a browser once the build
+completes.  Note that ``make check`` runs automatically when you submit
+a :ref:`pull request <pullrequest>`.  You may wish to run ``make check``
+and ``make linkcheck`` to make sure that it runs without errors.
+
+.. _separate repository:
+.. _devguide repo: https://github.com/python/devguide
+.. _devguide GitHub tracker: https://github.com/python/devguide/issues
+.. _Sphinx: https://www.sphinx-doc.org/

documentation/help-documenting.rst

@@ -82,58 +82,4 @@ a pull request directly. It's best to avoid filing a single issue for an entire
 section containing multiple problems; instead, file several issues so that it
 is easier to break the work up for multiple people and more efficient review.
 
-
-.. _helping-with-the-developers-guide:
-
-Helping with the Developer's Guide
-----------------------------------
-
-.. highlight:: console
-
-The Developer's Guide (what you're reading now) uses the same process as the
-main Python documentation, except for some small differences.  The source
-lives in a `separate repository`_ and bug reports should be submitted to the
-`devguide GitHub tracker`_.
-
-Our devguide workflow uses continuous integration and deployment so changes to
-the devguide are normally published when the pull request is merged. Changes
-to CPython documentation follow the workflow of a CPython release and are
-published in the release.
-
-
-Developer's Guide workflow
---------------------------
-
-To submit a :ref:`pull request <pullrequest>`, you can fork the
-`devguide repo`_ to your GitHub account and clone it using::
-
-    $ git clone https://github.com/<your_username>/devguide
-
-For your PR to be accepted, you will also need to sign the
-:ref:`contributor agreement <cla>`.
-
-To build the devguide, some additional dependencies are required (most
-importantly, `Sphinx`_), and the standard way to install dependencies in
-Python projects is to create a virtualenv, and then install dependencies from
-a ``requirements.txt`` file. For your convenience, this is all *automated for
-you*. To build the devguide on a Unix-like system use::
-
-   $ make html
-
-in the checkout directory.  On Windows use:
-
-.. code-block:: doscon
-
-   > .\make html
-
-You will find the generated files in ``_build/html`` or, if you use
-``make htmlview``, the docs will be opened in a browser once the build
-completes.  Note that ``make check`` runs automatically when you submit
-a :ref:`pull request <pullrequest>`.  You may wish to run ``make check``
-and ``make linkcheck`` to make sure that it runs without errors.
-
-.. _separate repository:
-.. _devguide repo: https://github.com/python/devguide
-.. _devguide GitHub tracker: https://github.com/python/devguide/issues
-.. _Sphinx: https://www.sphinx-doc.org/
 .. _issue tracker: https://github.com/python/cpython/issues

documentation/index.rst

@@ -10,3 +10,4 @@ Documentation
    style-guide
    markup
    translating
+   devguide

index.rst

@@ -6,7 +6,7 @@ Python Developer's Guide
 
 This guide is a comprehensive resource for :ref:`contributing <contributing>`
 to Python_ -- for both new and experienced contributors. It is
-:ref:`maintained <helping-with-the-developers-guide>` by the same
+:ref:`maintained <devguide>` by the same
 community that maintains Python.  We welcome your contributions to Python!
 
 .. _quick-reference:
@@ -259,7 +259,7 @@ Additional Resources
 --------------------
 
 * Anyone can clone the sources for this guide.  See
-  :ref:`helping-with-the-developers-guide`.
+  :ref:`devguide`.
 * Help with ...
     * :ref:`exploring`
     * :ref:`grammar`