Reorganise the devguide to directories

clang.rst → advanced-tools/clang.rst

@@ -1,6 +1,8 @@
-***************************
+.. _clang:
+
+===========================
 Dynamic Analysis with Clang
-***************************
+===========================
 
 .. highlight:: bash
 

coverity.rst → advanced-tools/coverity.rst

@@ -1,9 +1,9 @@
+.. _coverity:
+
 =============
 Coverity Scan
 =============
 
-.. _coverity:
-
 Coverity Scan is a free service for static code analysis of Open Source
 projects. It is based on Coverity's commercial product and is able to analyze
 C, C++ and Java code.

gdb.rst → advanced-tools/gdb.rst

@@ -1,6 +1,7 @@
 .. _gdb:
 
-gdb Support
+===========
+GDB Support
 ===========
 
 .. highlight:: none
@@ -17,7 +18,7 @@ limitation.
 
 
 gdb 7 and later
----------------
+===============
 
 In gdb 7, support for `extending gdb with Python
 <https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python>`_ was
@@ -300,7 +301,7 @@ thread is doing at the Python level::
 
 
 gdb 6 and earlier
------------------
+=================
 
 The file at ``Misc/gdbinit`` contains a gdb configuration file which provides
 extra commands when working with a CPython process. To register these commands
@@ -311,7 +312,7 @@ from your gdb session.
 
 
 Updating auto-load-safe-path to allow test_gdb to run
------------------------------------------------------
+=====================================================
 
 ``test_gdb`` attempts to automatically load additional Python specific
 hooks into gdb in order to test them. Unfortunately, the command line

advanced-tools/index.rst

@@ -0,0 +1,10 @@
+==============
+Advanced Tools
+==============
+
+.. toctree::
+ :maxdepth: 5
+
+ gdb
+ clang
+ coverity

conf.py

@@ -29,7 +29,12 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx_copybutton']
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx_copybutton',
+ 'sphinxext.rediraffe',
+]
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
 todo_include_todos = True
 
@@ -226,6 +231,44 @@
  # match any anchor that starts with a '/' since this is an invalid HTML anchor
  '\/.*',
 ]
+rediraffe_redirects = {
+ "clang.rst": "advanced-tools/clang.rst",
+ "coverity.rst": "advanced-tools/coverity.rst",
+ "gdb.rst": "advanced-tools/gdb.rst",
+ "coredev.rst": "core-developers/become-core-developer.rst",
+ "committing.rst": "core-developers/committing.rst",
+ "developers.rst": "core-developers/developer-log.rst",
+ "experts.rst": "core-developers/experts.rst",
+ "motivations.rst": "core-developers/motivations.rst",
+ "c-api.rst": "developer-workflow/c-api.rst",
+ "communication.rst": "developer-workflow/communication-channels.rst",
+ "devcycle.rst": "developer-workflow/development-cycle.rst",
+ "extensions.rst": "developer-workflow/extension-modules.rst",
+ "grammar.rst": "developer-workflow/grammar.rst",
+ "langchanges.rst": "developer-workflow/lang-changes.rst",
+ "porting.rst": "developer-workflow/porting.rst",
+ "stdlibchanges.rst": "developer-workflow/stdlib.rst",
+ "docquality.rst": "documentation/help-documenting.rst",
+ "documenting.rst": "documentation/start-documenting.rst",
+ "fixingissues.rst": "getting-started/fixing-issues.rst",
+ "help.rst": "getting-started/getting-help.rst",
+ "gitbootcamp.rst": "getting-started/git-boot-camp.rst",
+ "pullrequest.rst": "getting-started/pull-request-lifecycle.rst",
+ "setup.rst": "getting-started/setup-building.rst",
+ "compiler.rst": "internals/compiler.rst",
+ "exploring.rst": "internals/exploring.rst",
+ "garbage_collector.rst": "internals/garbage-collector.rst",
+ "parser.rst": "internals/parser.rst",
+ "buildbots.rst": "testing/buildbots.rst",
+ "coverage.rst": "testing/coverage.rst",
+ "buildworker.rst": "testing/new-buildbot-worker.rst",
+ "runtests.rst": "testing/run-write-tests.rst",
+ "silencewarnings.rst": "testing/silence-warnings.rst",
+ "gh-faq.rst": "triage/github-bpo-faq.rst",
+ "tracker.rst": "triage/issue-tracker.rst",
+ "gh-labels.rst": "triage/labels.rst",
+ "triaging.rst": "triage/triaging.rst",
+}
 
 linkcheck_ignore = [
  # The voters repo is private and appears as a 404
@@ -238,6 +281,8 @@
  'https://discuss.python.org/groups/admins',
 ]
 
+
+
 # Use our custom CSS stylesheet to differentiate us from the official python
 # docs.
 def setup(app):

core-developers/become-core-developer.rst

@@ -0,0 +1,59 @@
+.. _become-core-developer:
+.. _coredev:
+
+==============================
+How to Become a Core Developer
+==============================
+
+What it Takes
+=============
+
+When you have consistently contributed patches which meet quality standards
+without requiring extensive rewrites prior to being committed,
+you may qualify for commit privileges and become a core developer of Python.
+You must also work well with other core developers (and people in general)
+as you become an ambassador for the Python project.
+
+Typically a core developer will offer you the chance to gain commit privilege.
+The person making the offer will become your mentor and watch your commits for
+a while to make sure you understand the development process. If other core
+developers agree that you should gain commit privileges you are then extended
+an official offer. How core developers come to that agreement are outlined in
+:pep:`13`.
+
+
+Gaining Commit Privileges
+=========================
+
+The steps to gaining commit privileges are:
+
+1. A core developer starts a poll at https://discuss.python.org/c/committers/5
+
+ - Open for 7 days
+ - Results shown upon close
+
+2. The poll is announced on python-committers
+3. Wait for the poll to close and see if the results confirm your membership
+ as per the voting results required by PEP 13
+4. The person who nominated you emails the steering council with your email
+ address and a request that the council either accept or reject the proposed
+ membership
+5. Assuming the steering council does not object, a member of the council will
+ email you asking for:
+
+ - Account details as required by
+ 🔒 https://github.com/python/voters/
+ - Your preferred email address to
+ subscribe to python-committers with
+ - A reminder about the `Code of Conduct`_ and to report issues to the PSF
+ Conduct WG
+
+6. Once you have provided the pertinent details, your various new privileges
+ will be turned on
+7. Your details will be added to 🔒 https://github.com/python/voters/
+8. They will update the devguide to publicly list your team membership at
+ :ref:`developers`
+9. An announcement email by the steering council member handling your new
+ membership will be sent to python-committers
+
+.. _Code of Conduct: https://www.python.org/psf/conduct/

committing.rst → core-developers/committing.rst

@@ -52,8 +52,8 @@ to enter the public source tree. Ask yourself the following questions:
  developer can apply the label ``needs backport to X.Y`` to the pull
  request. Once the backport pull request has been created, remove the
  ``needs backport to X.Y`` label from the original pull request. (Only
- core developers and members of the `Python Triage Team`_ can apply
- labels to GitHub pull requests).
+ core developers and members of the :ref:`Python Triage Team <triage-team>`
+ can apply labels to GitHub pull requests).
 
 * **Does the pull request pass a check indicating that the submitter has signed the CLA?**
  Make sure that the contributor has signed a `Contributor
@@ -224,11 +224,10 @@ Note that cherry_picker.py_ adds the branch prefix automatically.
 
 Once the backport pull request has been created, remove the
 ``needs backport to X.Y`` label from the original pull request. (Only
-core developers and members of the `Python Triage Team`_ can apply
-labels to GitHub pull requests).
+core developers and members of the :ref:`Python Triage Team <triage-team>`
+can apply labels to GitHub pull requests).
 
 .. _cherry_picker.py: https://github.com/python/cherry-picker
-.. _`Python Triage Team`: https://devguide.python.org/triaging/#python-triage-team
 
 
 Reverting a merged pull request

developers.rst → core-developers/developer-log.rst

@@ -1,3 +1,4 @@
+.. _developer-log:
 .. _developers:
 
 Developer Log

experts.rst → core-developers/experts.rst

@@ -1,5 +1,6 @@
 .. _experts:
 
+=============
 Experts Index
 =============
 
@@ -44,7 +45,8 @@ not feel qualified to make a decision in a particular context.
 
 
 Stdlib
-------
+======
+
 ==================== =============================================
 Module Maintainers
 ==================== =============================================
@@ -276,7 +278,8 @@ zlib Yhg1s, gpshead*
 
 
 Tools
------
+=====
+
 ================== ===========
 Tool Maintainers
 ================== ===========
@@ -286,7 +289,8 @@ PEG Generator gvanrossum, pablogsal, lysnikolaou
 
 
 Platforms
----------
+=========
+
 =================== ===========
 Platform Maintainers
 =================== ===========
@@ -305,7 +309,8 @@ JVM/Java frank.wierzbicki^
 
 
 Miscellaneous
--------------
+=============
+
 ================== ==========================================================
 Interest Area Maintainers
 ================== ==========================================================
@@ -359,6 +364,6 @@ version control merwok, ezio-melotti
 
 
 Documentation Translations
---------------------------
+==========================
 
 For a list of translators, see :ref:`this table about translations <translating>`.

core-developers/index.rst

@@ -0,0 +1,13 @@
+===============
+Core Developers
+===============
+
+.. toctree::
+ :maxdepth: 5
+
+ responsibilities
+ committing
+ experts
+ developer-log
+ motivations
+ become-core-developer