Skip to content

Preview of documentation #5

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

Closed
wants to merge 3 commits into from
Closed

Preview of documentation #5

wants to merge 3 commits into from

Conversation

devmotion
Copy link
Member

No description provided.

@devmotion
Copy link
Member Author

Ah this needs more changes, the custom DeployConfig overwrites the pull_request event and so Documenter does not create a preview build but instead rebuilds the actual docs since it assumes we pushed to master.

It seems one should also not build both stable and dev in a PR. In general, maybe there should be separate triggers for the stable builds only if there is a new release of Turing - it seems a bit strange to rebuild it every time the action is executed.

@devmotion
Copy link
Member Author

Maybe one should first separate the repo more clearly from Turing, as discussed in TuringLang/Turing.jl#1474.

@cpfiffer
Copy link
Member

Ah this needs more changes, the custom DeployConfig overwrites the pull_request event and so Documenter does not create a preview build but instead rebuilds the actual docs since it assumes we pushed to master.

We should probably just check an environment variable here -- the deploy config I added was to allow this to function more like a cron job, but maybe there's a better way to do it.

It seems one should also not build both stable and dev in a PR. In general, maybe there should be separate triggers for the stable builds only if there is a new release of Turing - it seems a bit strange to rebuild it every time the action is executed.

This was a quick hack to get it to remain current. I wasn't able to find a way to have GitHub report pulls/releases in other repos to this one, and this is a nice and easy stateless solution that doesn't require talking to the main Turing.jl repo or performing any record keeping.

@cpfiffer
Copy link
Member

Maybe one should first separate the repo more clearly from Turing, as discussed in TuringLang/Turing.jl#1474.

I'm also not sure what you mean here -- everything that's in this repo is basically just website skeleton. The whole point of make.jl is to go grab any of Turing docs and build them in the website format. It's very separate from Turing.

@devmotion
Copy link
Member Author

I'm also not sure what you mean here -- everything that's in this repo is basically just website skeleton. The whole point of make.jl is to go grab any of Turing docs and build them in the website format. It's very separate from Turing.

I got confused by the setup and only realized this later. Just ignore this comment 🙂

@devmotion devmotion closed this Jan 26, 2021
@devmotion
Copy link
Member Author

This is not useful, as mentioned above it just rebuilds the stable and dev version of the docs. However, the main motivation would be to build it in a separate folder for each PR.

@devmotion devmotion deleted the dw/preview branch May 3, 2022 19:50
shravanngoswamii pushed a commit that referenced this pull request Apr 14, 2025
* paste in svg

* responsive svg header
shravanngoswamii pushed a commit that referenced this pull request Apr 21, 2025
* paste in svg

* responsive svg header
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants