Skip to content
This repository has been archived by the owner on Sep 10, 2023. It is now read-only.

Convert all existing models to Literate #59

Merged
merged 8 commits into from
Jan 8, 2021
Merged

Convert all existing models to Literate #59

merged 8 commits into from
Jan 8, 2021

Conversation

rikhuijzer
Copy link
Contributor

@rikhuijzer rikhuijzer commented Jan 7, 2021

After this PR, all files in models contain \literate{/scripts/...}.

Copy link
Member

@goedman goedman left a comment

Choose a reason for hiding this comment

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

Difficult to review in this format. I prefer to check it using the website.

@rikhuijzer
Copy link
Contributor Author

rikhuijzer commented Jan 7, 2021

Difficult to review in this format. I prefer to check it using the website.

As far as I know, there are a few ways to make that possible:

  1. I push directly to master and we fix from there. This might be a bit unwieldy when, at a later point in time, people start sending in PRs which we have to check.
  2. In the GitHub Action, push pull requests to a different folder (like PR), so that https://statisticalrethinkingjulia.github.io/TuringModels.jl/PR/ would show the site for the latest pull-request. This option is quite easy to achieve but multiple pull requests will then overlap.
  3. Like the previous one but send the PRs to different folders in the gh-pages branch.

Usually, Netlify is the best option for showing pull request web pages. However, I think we would run out of build minutes there and I'm not sure whether the build image includes Julia. I've been messing with their build image before and noticed that you don't have sudo permissions.

EDIT: In accordance with Occam's Razor, lets just simply fail the build if anything happens when Franklin builds the pages. Then, we only have to inspect the code for strange things and can be assured that the build will succeed after the merge. To be more sure, we can of course always add tests and asserts as always. To view the site locally use

julia -ie --project 'using Franklin; Franklin.serve()'

and open http://localhost:8000/ in the browser.

@rikhuijzer
Copy link
Contributor Author

rikhuijzer commented Jan 7, 2021

The pull request is unfinished by the way, which I try to indicate with the Draft label. I thought it would be easier this way to see what work is in progress.

@rikhuijzer rikhuijzer marked this pull request as ready for review January 8, 2021 21:43
@rikhuijzer rikhuijzer merged commit bc260b2 into master Jan 8, 2021
@rikhuijzer rikhuijzer deleted the literate branch January 8, 2021 21:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants