What this MR does / why does DuMux need it:
Adds the highlevel documentation of dumux.
Notes for the reviewer
TODO: insert text here
Before you request a review from someone, make sure to revise the following points:
-
does the new code follow the style guide? -
do the test pipelines pass? (see guide on how to run pipelines for a merge request) -
is the code you changed and/or the new code you wrote covered in the test suite? (if not, extend the existing tests or write new ones) -
does your change affect public interfaces or behavior, or, does it introduce a new feature? If so, document the change in CHANGELOG.md. -
is the list of the header includes complete? ("include what you use") -
all files have to end with a \ncharacter. Make sure there is no\ No newline at end of filecomment in "Changes" of this MR. -
(if not applicable remove) are newly introduced or modified physical values/functions backed up with a scientific reference (including doi) in the docs? -
(if not applicable remove) if the examples are modified, is the documentation regenerated (using generate_example_docs.py)