I have looked at the Literate package as you and @pkofod mentioned and have produced a tutorial but since I cannot send any files via the Discourse forum I would appreciate some guidance. I need another pair (or two) of eyes to check my Jupyter notebook and Markdown file (which was very easy to create, BTW).
That was quick I’ll see if I can enable the Literate examples in the Optim.jl documentation today or tomorrow, and then you can submit your example as a PR to Optim.
Uploading the Literate file as a gist, as @Tamas_Papp suggested is also a good way to show us the tutorial.
The name of the gist in both cases is “Maximum Likelihood Estimation in Julia: The Normal Linear Model”.
I tried to add a TIP to the markdown but it is not rendering correctly and I’m happy to make any corrections that anyone can point out in terms of errors or clarifications.
As for the speed of the work, I’ve been given the fortune to discover this community and Julia and just wish to provide something in return.
If you wish, I can add your tutorial to the Literate PR I made to Optim just now, but then I would need a gist of the original jl file and not the Markdown or ipynb files.
Alternatively, you can follow the steps I did there and submit a PR yourself if you would like to do that instead (but then I advise waiting for my PR to be merged)
The Markdown TIP is written in a way so that it will work when the documentation is deployed (after it has been merged to the master branch on Optim. But that is all taken care of automatically so you can just copy-paste what I did in my example (you’ll have to change the file names, however )
As you can see, it’s a Julia script and I’m happy for you to do the PR…
I’ll need to learn more about GitHub and PR’s. For some reason PR’s make me nervous and I don’t want to be “that guy” who completely destroyed the Julia ecosystem with one mouse click.
You can’t. With a version control system you can always backtrack, and in any case PRs are like suggestions, to be reviewed by the repo maintainers. It is OK to make git mistakes too, you can always correct them.