Skip to content

Commit

Permalink
Infra: Add note on finding the RTD preview (#2551)
Browse files Browse the repository at this point in the history
It's very useful but a bit buried. Hopefully this will help more people find it.

Co-authored-by: CAM Gerlach <[email protected]>
  • Loading branch information
JelleZijlstra and CAM-Gerlach authored Apr 24, 2022
1 parent 5673bc4 commit 24dec44
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://readthedocs.org/>`_.
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
-------------------

Expand Down

0 comments on commit 24dec44

Please sign in to comment.