- Getting started
- Development workflow
- Issues and triaging
- Documentation
- Testing and buildbots
- Development tools
- Core team
- CPython’s internals
- Status of Python versions
- Python Contributor’s Guide (draft)
- [Plan for the Contributor’s Guide]
- Introduction
- The CPython project
- Issues and triaging
- Documentation contributions
- Code contributions
- Core team
- Accessibility, design, and user success
- Security and infrastructure contributions
- Workflows
Helping with the Developer’s Guide¶
The Developer’s Guide (what you’re reading now) uses the same process as themain Python documentation, except for some small differences. The sourcelives in aseparate repository and bug reports should be submitted to thedevguide GitHub tracker.
Changes to the Developer’s Guide are published when pull requests are merged.
Changes to the Python documentation are published regularly,ususally within 48 hours of the change being committed.The documentation is alsopublished for each release,which may also be used by redistributors.
Developer’s Guide workflow¶
To submit apull request, you can fork thedevguide repo to your GitHub account and clone it using:
$gitclonehttps://github.com/<your_username>/devguideFor your PR to be accepted, you will also need to sign thecontributor agreement.
To build the devguide, some additional dependencies are required (mostimportantly,Sphinx), and the standard way to install dependencies inPython projects is to create a virtualenv, and then install dependencies fromarequirements.txt file. For your convenience, this is allautomated foryou.
To build the devguide from the checkout directory:
makehtml
.\make html
You will find the generated files in_build/html.
Tip
Replace
htmlwithhtmlviewto open the docs in a web browseronce the build completes.Replace
htmlwithhtmlliveto rebuild the docs,start a local server, and automatically reload the page in yourbrowser when you make changes to reST files (Unix only).
Note thatmakecheck runs automatically when you submitapull request. You may wish to runmakecheckandmakelinkcheck to make sure that it runs without errors.