Restructuring the website #32
Conversation
* Modify github actions to copy notebooks to website directory before building the website * Execution of notebooks is set to 'off' * Include workflow normally done by github actions into CONTRIBUTING.md so that users can actually build the website locally
There was a problem hiding this comment.
@NoraLoose if fig_1.png is now in website/ maybe we can delete it from the repo root? (IIUC the copy there now is a duplicate?)
There was a problem hiding this comment.
We should include website/fig_1.png in the .gitignore.
As of now, both the README and fig_1.png are copied to website/ by GitHub actions before the website is built. That is because you can't include files in the website that live outside the website/ directory. Copying only README over would lead to conflicting paths for where to find the figure (for showing the README vs. building the website).
Maybe a cleaner solution would be to have separate markdown files in website/ (which break up the README into sections).
There was a problem hiding this comment.
Copying only README over would lead to conflicting paths for where to find the figure (for showing the README vs. building the website)
haha 🤯 yikes yeah I see your point there
|
I have set the execution of notebooks is set to 'off', see If we want to execute the notebooks at build time, we have to include a lot more packages in |
I think this is the right call for now. Eventually, it would be great to run the notebooks automatically to ensure reproducibility, but that's too heavy a lift for now IMO. I'll open a separate issue to track that. Edit: tracking this in #33 |
Closes #15.
To reiterate, this PR mainly
EDIT:
Next steps: