# Preview of Documenter site for a PR branch

**URL:** <https://discourse.julialang.org/t/preview-of-documenter-site-for-a-pr-branch/119059>\
**Category:** General Usage\
**Tags:** documenter, github\
**Created:** [September 5, 2024, 1:19am UTC](https://discourse.julialang.org/t/preview-of-documenter-site-for-a-pr-branch/119059 "2024-09-05T01:19:56Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![mike.ingold](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mike.ingold/32/203749_2.png) [@mike.ingold](https://discourse.julialang.org/u/mike.ingold)\
**Post date:** [September 5, 2024, 1:19am UTC](https://discourse.julialang.org/t/preview-of-documenter-site-for-a-pr-branch/119059/1 "2024-09-05T01:19:56Z")

</div>

I have a repo on GitHub with Documenter deplored in the standard configuration. When a PR is created, a Documenter action is being run that seems to build the site for that branch, but I can’t figure out how to actually view it. Is this something I need to perform extra steps to configure, or is there a trick to it?

---

<div class="post-metadata">

**Author:** ![gdalle](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/gdalle/32/27854_2.png) [@gdalle](https://discourse.julialang.org/u/gdalle)\
**Post date:** [September 5, 2024, 6:25am UTC](https://discourse.julialang.org/t/preview-of-documenter-site-for-a-pr-branch/119059/2 "2024-09-05T06:25:19Z")

</div>

I regularly find myself searching for `push_preview` in the Documenter API to answer this very question. It’s a keyword argument to [`Documenter.deploydocs`](https://documenter.juliadocs.org/stable/lib/public/#Documenter.deploydocs) and it behaves as follows:

> **`push_preview`** a boolean that specifies if preview documentation should be deployed from pull requests or not. If your published documentation is hosted at `"https://USER.github.io/PACKAGE.jl/stable`, by default the preview will be hosted at `"https://USER.github.io/PACKAGE.jl/previews/PR##"`. This feature works for pull requests with head branch in the same repository, i.e. not from forks.

---

<div class="post-metadata">

**Author:** ![thofma](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/thofma/32/1691_2.png) [@thofma](https://discourse.julialang.org/u/thofma)\
**Post date:** [September 5, 2024, 3:14pm UTC](https://discourse.julialang.org/t/preview-of-documenter-site-for-a-pr-branch/119059/3 "2024-09-05T15:14:53Z")

</div>

If you mean “how to access this from the PR page”, one of the actions should be labelled “documenter/deploy”. If you click on “details” of this action, you should get redirected to the preview. For your PR [here](https://github.com/mikeingold/MeshIntegrals.jl/pull/63), the actions are hidden under “show all checks” and the “documenter/deploy” is the last action in the list.

Edit: I think you already figured it out, but I’ll keep the answer for future readers.