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.

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

Support push preview docs. #1180

Merged
merged 1 commit into from
Nov 16, 2019
Merged

Support push preview docs. #1180

merged 1 commit into from
Nov 16, 2019

Conversation

fredrikekre
Copy link
Member

@fredrikekre fredrikekre commented Nov 16, 2019

Documenter can now push preview docs from PRs (when the head branch is from the same repository). This is enabled by passing push_preview=true to deploydocs. Documenter will then push rendered documentation to previews/PR## where ## is the pull request number.

@fredrikekre
Copy link
Member Author

See fredrikekre/Literate.jl#80

@fredrikekre
Copy link
Member Author

Resulting page: https://fredrikekre.github.io/Literate.jl/previews/PR80/

Documenter can now push preview docs from PRs
(when the head branch is from the same repository).
This is enabled by passing push_preview=true to deploydocs.
Documenter will then push rendered documentation
to preview/PR## where ## is the pull request number.
@fredrikekre
Copy link
Member Author

Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, thanks @fredrikekre!

@@ -747,8 +747,7 @@ function doctest(
)
true
catch err
@error "Doctesting failed"
showerror(stdout, err, catch_backtrace())
@error "Doctesting failed" exception=(err, catch_backtrace())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't know that this works 👍

@fredrikekre fredrikekre merged commit 40c0f53 into master Nov 16, 2019
@fredrikekre fredrikekre deleted the fe/preview branch November 16, 2019 22:29
asinghvi17 added a commit to JuliaDynamics/DrWatson.jl that referenced this pull request Feb 9, 2020
Datseris pushed a commit to JuliaDynamics/DrWatson.jl that referenced this pull request Feb 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants