diff --git a/README.rst b/README.rst index 8e481451132..db00cf13017 100644 --- a/README.rst +++ b/README.rst @@ -24,6 +24,18 @@ generation to fail, or result in major rendering defects relative to what you intend. +Browse the ReadTheDocs preview +------------------------------ + +For every PR, we automatically create a preview of the rendered PEPs using +`ReadTheDocs `_. +You can find it in the merge box at the bottom of the PR page: + +1. Click "Show all checks" to expand the checks section +2. Find the line for ``docs/readthedocs.org:pep-previews`` +3. Click on "Details" to the right + + Render PEPs locally -------------------