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 team.

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