diff --git a/_static/devguide_overrides.css b/_static/devguide_overrides.css index 625a9dda2d..abe61bcdcd 100644 --- a/_static/devguide_overrides.css +++ b/_static/devguide_overrides.css @@ -27,3 +27,9 @@ table.docutils td { vertical-align: top; } + +/* For the video in index.rst */ +[role="main"] .compact-video { + max-width: 500px; + margin-inline: auto; +} diff --git a/conf.py b/conf.py index fb032b895c..020e6bf6af 100644 --- a/conf.py +++ b/conf.py @@ -11,6 +11,7 @@ 'sphinx_copybutton', 'sphinx_inline_tabs', 'sphinx_last_updated_by_git', + 'sphinxcontrib.youtube', 'sphinxext.opengraph', 'sphinxext.rediraffe', ] diff --git a/index.rst b/index.rst index 23ed08e151..f6bd875f06 100644 --- a/index.rst +++ b/index.rst @@ -1,4 +1,5 @@ .. _devguide-main: +.. _contributing: ======================== Python Developer's Guide @@ -8,24 +9,16 @@ Python Developer's Guide .. highlight:: bash -This guide is a comprehensive resource for :ref:`contributing ` +This guide is a comprehensive resource for contributing to Python_ -- for both new and experienced contributors. It is :ref:`maintained ` by the same community that maintains Python. We welcome your contributions! - -.. _contributing: - -Contributing ------------- - -We encourage everyone to contribute to Python. To help you, we have put up this -developer's guide. If you still have questions after reviewing the material in +Start with the area that best matches what you want to do. +If you still have questions after reviewing the material in this guide, then the `Core Python Mentorship`_ group is available to help guide new contributors through the process. -Guide for contributing to Python: - .. list-table:: :widths: 10 10 10 :header-rows: 1 @@ -63,15 +56,23 @@ Guide for contributing to Python: We **recommend** that sections of this guide be read as needed. You can stop where you feel comfortable and begin contributing immediately without reading and understanding everything. If you do choose to skip -around within the guide, be aware that sections build on each other, -so you may find it necessary to backtrack to fill in -missing concepts and terminology. +around within the guide, be aware that some sections build on each other, +so you may need to backtrack for missing concepts or terminology. -A number of individuals from the Python community have contributed to a series +For broader open-source contribution advice, a number of individuals from the +Python community have contributed to a series of excellent guides at `Open Source Guides `__. For example, `How to Contribute to Open Source `__. +.. admonition:: You don't have to be a compiler engineer to work on Python -- Savannah Ostrowski + + .. container:: compact-video + + .. youtube:: WGXXxGLBVF4 + :privacy_mode: + :width: 100% + .. _quick-reference: diff --git a/requirements.txt b/requirements.txt index 5dfb12f146..789f9597a3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ sphinx-last-updated-by-git>=0.3.8 sphinx-lint==1.0.2 sphinx-notfound-page>=1.1.0 sphinx_copybutton>=0.5.2 +sphinxcontrib-youtube>=1.5.0 sphinxext-opengraph>=0.13.0 sphinxext-rediraffe Sphinx>=9.1.0