search

oscar-system / book.oscar-system.org

https://book.oscar-system.org
0 stars 6 forks source link

Restructure example generation #18

Closed lkastner closed 3 months ago

lkastner commented 3 months ago

Some of the examples require some code to run before, like adding packages, otherwise they do not work. I added these missing snippets.

Furthermore the examples are now generated from the examples_templates folder. Then one could insert explanations in between the examples in the template files, if that is something we want to do in the long run. For example we could add chapter titles etc. there.

aaruni96 commented 3 months ago

If I understand this correctly, examples_templates are what authors should modify manually, and then the auto generate script actually assembles the page which is displayed? (which then allows exposition between code blocks and such things)

Okay, the question is need less if I actually read the Readme instead of everything except the readme.

Looks good to me.