8000 Infra: Add note on finding the RTD preview (#2551) · python/peps@24dec44 · GitHub
[go: up one dir, main page]

Skip to content

Commit 24dec44

Browse files
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 <CAM.Gerlach@Gerlach.CAM>
1 parent 5673bc4 commit 24dec44

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ generation to fail, or result in major rendering defects relative to what you
2424
intend.
2525

2626

27+
Browse the ReadTheDocs preview
28+
------------------------------
29+
30+
For every PR, we automatically create a preview of the rendered PEPs using
31+
`ReadTheDocs <https://readthedocs.org/>`_.
32+
You can find it in the merge box at the bottom of the PR page:
33+
34+
1. Click "Show all checks" to expand the checks section
35+
2. Find the line for ``docs/readthedocs.org:pep-previews``
36+
3. Click on "Details" to the right
37+
38+
2739
Render PEPs locally
2840
-------------------
2941

0 commit comments

Comments
 (0)
0