search

MDAIceland / WaterSecurity

1 stars 1 forks source link

Documentation Generation #50

Closed bajo1207 closed 3 years ago

bajo1207 commented 3 years ago

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

bajo1207 commented 3 years ago

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 commented 3 years ago

Git wants to make changes on _prep_hdrov2.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_hdrov2.ipynb here in this pull request?

Have you committed changes locally to that notebook?

bajo1207 commented 3 years ago

I unintentionally added it in this commit c83f9dd296827826c98ebea9c67d89dab8bda4a5.

VasLem commented 3 years ago

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 commented 3 years ago

Thanks! 👍 Should be all right to merge now.

VasLem commented 3 years ago

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:

VasLem commented 3 years ago

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

bajo1207 commented 3 years ago

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.