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

Having documentation preview in PR would be really handy for reviewing #958

Closed
glemaitre opened this issue Dec 14, 2024 · 3 comments · Fixed by #1027 or #981
Closed

Having documentation preview in PR would be really handy for reviewing #958

glemaitre opened this issue Dec 14, 2024 · 3 comments · Fixed by #1027 or #981
Assignees
@thomass-dev
Labels
documentation Improvements or additions to documentation user-reported

Comments

@glemaitre
Copy link
Member

glemaitre commented Dec 14, 2024 •
edited
Loading

As mentioned in a #733, I think it would be really worth having a preview for the documentation in PR to be able to do a proper review and see if there is any glitches in the rendering.

Circle CI + a GitHub Actions to redirect is something that we use in scikit-learn and skrub.

I did a couple of documentation PRs and it is something that I missed.
@thomass-dev
Copy link
Collaborator

We should think of a solution, but yes it's a good feature.Thanks.

@thomass-dev thomass-dev self-assigned this Dec 16, 2024
@tuscland tuscland added needs-triage This has been recently submitted and needs attention user-reported documentation Improvements or additions to documentation and removed needs-triage This has been recently submitted and needs attention labels Dec 17, 2024
@thomass-dev thomass-dev linked a pull request Dec 27, 2024 that will close this issue
ci: Add workflow to serve documentation preview in PRs #1027
Merged
@thomass-dev
Copy link
Collaborator

thomass-dev commented Dec 27, 2024 •
edited
Loading

image

#1027 (comment)

@thomass-dev thomass-dev linked a pull request Jan 7, 2025 that will close this issue
ci: Refactor workflows so that they are usable by forks #981
Merged
@glemaitre
Copy link
Member Author

Nice. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thomass-dev thomass-dev

Labels
documentation Improvements or additions to documentation user-reported
Projects
None yet
Milestone
No milestone
3 participants
@tuscland @thomass-dev @glemaitre