Skip to content

Commit

Permalink
Add a README
Browse files Browse the repository at this point in the history
  • Loading branch information
brettcannon committed Jul 22, 2016
1 parent b327e3d commit 36683ad
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The CPython Developer's Guide
=============================

This guide covers how to contribute to CPython. It is known by the
nickname of "the devguide" by the Python core developers.

The official home of this guide is https://docs.python.org/devguide/,
but an up-to-date mirror of this repository is also available at
http://cpython-devguide.readthedocs.io/en/latest/ (use the mirror if
you want to verify that a recent change worked well as the copy on
docs.python.org is updated only a few times a day).


GitHub work
-----------

If you wish to contribute to updating the devguide then please submit
PRs to the
[`github` branch](https://github.com/python/devguide/tree/github).
You can view the rendered version of this branch at
http://cpython-devguide.readthedocs.io/en/github/.
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'venv*', 'env*']
exclude_patterns = ['_build', 'venv*', 'env*', 'README.rst']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
Expand Down

0 comments on commit 36683ad

Please sign in to comment.