Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Infra: Add note on finding the RTD preview #2551

Merged
merged 2 commits into from
Apr 24, 2022
Merged

Infra: Add note on finding the RTD preview #2551

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
552ff86
Add note on finding the RTD preview
JelleZijlstra Apr 23, 2022
abeab82
CAMpliance
JelleZijlstra Apr 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ Please don't commit changes with reStructuredText syntax errors that cause PEP
generation to fail, or result in major rendering defects relative to what you
intend.

ReadTheDocs preview
-------------------
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved

For every PR, we automatically create a preview of the rendered PEPs using
ReadTheDocs. You can find it in the branch action box at the bottom of the
PR page:
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved

- Click "Show all checks" to expand the box
- Find the line for ``docs/readthedocs.org:pep-previews``
- Click on "Details" to the right
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved


Render PEPs locally
-------------------
Expand Down