Documentation Generation

[bajo1207]

Merge documentation generation to be able to generate documentation on the master branch.

[bajo1207]

Git wants to make changes on prep_hdro_v2.ipynb. I've tried to merge master into branch first, but for some reason it says that everything is up to date.. Is it possible to make github not consider the changes to prep_hdro_v2.ipynb here in this pull request?

[VasLem]

Git wants to make changes on prep_hdro_v2.ipynb. I've tried to merge master into branch first, but for some reason it says that everything is up to date.. Is it possible to make github not consider the changes to prep_hdro_v2.ipynb here in this pull request?

Have you committed changes locally to that notebook?

[bajo1207]

I unintentionally added it in this commit c83f9dd.

[VasLem]

If you want to drop the changes you can checkout the file from master using:
git checkout master -- FILE_PATH
(while in the current branch)
(and you need to git add, commit and push the change)
If you don't want to drop them, copy it somewhere beforehand and then paste it back once you have changed to the branch it was supposed to be. (hacky solution but the alternative sucks)

[bajo1207]

Thanks! 👍 Should be all right to merge now.

[VasLem]

Checked, everything looks nice. Only one question, could we also get to render jupyter notebooks inside the documentation? This is for a multitude of reasons:

• Allow user to access jupyter markdown while not in repository
• Allow user to see output of jupyter directly in the github pages
• Reference notebooks sequence required to run from the user
  Related to this which has preasummingly a solution here , which is implemented here

[VasLem]

By the way, do we need to make repository public for this to play?

[bajo1207]

As i wrote in #44:

In order to deploy it as on github pages, this repository needs to be public. I suggest we make the repo public right before we hand in the project, so the professor can explore our workflow etc. The documentation can also then be published, here is how to do it.

So for now, we don't need to make it public.