https://github.com/python/devguide

The Python developer's guide
https://github.com/python/devguide

Last synced: about 2 months ago
JSON representation

The Python developer's guide

• Host: GitHub
• URL: https://github.com/python/devguide
• Owner: python
• License: cc0-1.0
• Created: 2016-07-22T17:48:56.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T20:47:16.000Z (2 months ago)
• Last Synced: 2024-04-16T03:28:33.113Z (2 months ago)
• Language: Python
• Homepage: https://devguide.python.org/
• Size: 1.95 MB
• Stars: 1,747
• Watchers: 129
• Forks: 703
• Open Issues: 83
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Lists

• pycrumbs - The CPython Developer's Guide
• my-awesome-stars - python/devguide - The Python developer's guide (Python)
• my-awesome-stars - python/devguide - The Python developer's guide (Python)
• awesome-stars - python/devguide - The Python developer's guide (Python)

README

        
The CPython Developer's Guide

=============================

|ReadTheDocs| |Discourse| |Codestyle|

.. |ReadTheDocs| image:: https://readthedocs.org/projects/cpython-devguide/badge/

   :target: https://devguide.python.org

   :alt: Documentation Status

.. |Discourse| image:: https://img.shields.io/badge/discourse-join_chat-brightgreen.svg

   :alt: Python Discourse chat

   :target: https://discuss.python.org/

.. |Codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/psf/black

   :alt: Code style is black

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://devguide.python.org.

Render HTML

-----------

To render the devguide to HTML under ``_build/html``, run::

    make html

To render the devguide to HTML, and open the result in a browser, run::

    make htmlview

To maintain a live view of edits as they are saved, run::

    make htmllive