From 24dec4419d611bf0aa667cbc1e3d821b7d903040 Mon Sep 17 00:00:00 2001 From: Jelle Zijlstra Date: Sun, 24 Apr 2022 06:33:56 -0700 Subject: [PATCH] Infra: Add note on finding the RTD preview (#2551) It's very useful but a bit buried. Hopefully this will help more people find it. Co-authored-by: CAM Gerlach --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index 8e4814511..db00cf130 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 -------------------