Documentation

[AliceHarang]

Create a documentation for the code

We have chosen to used doxygen directly to create the documentation. An other solution would be to use doxygen associated to phynx, using some "intermediate" tools.

• [x] Include the images
• [ ] Fix the latex formula
• [ ] Add a biblio section
• [x] Add a tutorial / example section
• [ ] Add a proper description of the code in first-page
• [x] Adjust the readme to link toward the doc
• [ ] Add version control on the doxygen doc or/and adjust old doc
• [x] Update badge (codacy and remove the build from Travis?)

Create some tutorial / example (basic/jupyter - python/Julia):

• [ ] CEA2008
• [ ] Aureli2020 (either CEA or Aureli)
• [x] How to setup river flood model
• [ ] How to setup tsunami model
• [ ] Understand and visualise BG_Flood outputs
• [x] Infiltration on Orowaiti

[AliceHarang]

Error to add pictures as describe in https://github.com/doxygen/doxygen/issues/6783

[CyprienBosserelle]

Do we want to add as a task to this branch: Some tutorials and more extensive documentation. I've been thinking of a few different items but I need somewhere to write the list.

[CyprienBosserelle]

Updated task list for tutorials