|
1 | | -The CPython Developer's Guide |
2 | | -============================= |
| 1 | +# The CPython Developer's Guide |
3 | 2 |
|
4 | | -|ReadTheDocs| |Discourse| |Codestyle| |
| 3 | +[](https://devguide.python.org) |
| 4 | +[](https://discuss.python.org/) |
| 5 | +[](https://github.com/psf/black) |
5 | 6 |
|
6 | | -.. |ReadTheDocs| image:: https://readthedocs.org/projects/cpython-devguide/badge/ |
7 | | - :target: https://devguide.python.org |
8 | | - :alt: Documentation Status |
| 7 | +Welcome to **The CPython Developer's Guide**, affectionately known as **the devguide** by the Python core team. This comprehensive guide provides essential information for contributing to CPython. |
9 | 8 |
|
10 | | -.. |Discourse| image:: https://img.shields.io/badge/discourse-join_chat-brightgreen.svg |
11 | | - :alt: Python Discourse chat |
12 | | - :target: https://discuss.python.org/ |
| 9 | +For the latest and official version of this guide, visit [devguide.python.org](https://devguide.python.org). |
13 | 10 |
|
14 | | -.. |Codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg |
15 | | - :target: https://github.com/psf/black |
16 | | - :alt: Code style is black |
| 11 | +## Quick Start |
17 | 12 |
|
| 13 | +### Rendering HTML |
18 | 14 |
|
19 | | -This guide covers how to contribute to CPython. It is known by the |
20 | | -nickname of "the devguide" by the Python core team. |
| 15 | +To build the developer guide into HTML format, execute the following command: |
21 | 16 |
|
22 | | -The official home of this guide is https://devguide.python.org. |
| 17 | +```bash |
| 18 | +make html |
| 19 | +``` |
23 | 20 |
|
24 | | -Render HTML |
25 | | ------------ |
| 21 | +### Previewing the Guide |
26 | 22 |
|
27 | | -To render the devguide to HTML under ``_build/html``, run:: |
| 23 | +To render the guide and view it in your browser, run: |
28 | 24 |
|
29 | | - make html |
| 25 | +```bash |
| 26 | +make htmlview |
| 27 | +``` |
30 | 28 |
|
31 | | -To render the devguide to HTML, and open the result in a browser, run:: |
| 29 | +### Live Editing |
32 | 30 |
|
33 | | - make htmlview |
| 31 | +For those who want to see changes in real-time, use: |
34 | 32 |
|
35 | | -To maintain a live view of edits as they are saved, run:: |
| 33 | +```bash |
| 34 | +make htmllive |
| 35 | +``` |
36 | 36 |
|
37 | | - make htmllive |
| 37 | +## Contribution Guidelines |
| 38 | + |
| 39 | +We welcome contributions! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more details on how you can help improve the CPython project. |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +Thank you for your interest in contributing to CPython! |
0 commit comments