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

Jump to bottom

PR preview #1583

Closed
srittau opened this issue Jan 14, 2024 · 3 comments
Closed

PR preview #1583

srittau opened this issue Jan 14, 2024 · 3 comments
Labels
topic: documentation Documentation-related issues and PRs

Comments

@srittau
Copy link
Collaborator

srittau commented Jan 14, 2024

Per Guido:

We should have a workflow to preview the Sphinx-generated HTML, as we have for CPython.

This seems to be fairly easy: https://docs.readthedocs.io/en/stable/pull-requests.html. I'll investigate.
@srittau srittau added the topic: documentation Documentation-related issues and PRs label Jan 14, 2024
@srittau
Copy link
Collaborator Author

srittau commented Jan 14, 2024

The preview build works, but it's not reported back to GitHub yet: https://typing--1578.org.readthedocs.build/en/1578/.

@srittau
Copy link
Collaborator Author

srittau commented Jan 14, 2024

The preview build is now linked in a PR under "Checks". When clicking "Details" on the readthedocs check, you'll get sent to the preview build. It would be nicer to have a link directly in the PR comments, but I think this will do for now.

@srittau srittau closed this as completed Jan 14, 2024
@JelleZijlstra
Copy link
Member

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
topic: documentation Documentation-related issues and PRs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@srittau @JelleZijlstra