Extend readthedocs documentation (!38) · Merge requests · dumux-appl / dumux-preCICE · GitLab

This is an archived project. Repository and other project resources are read-only.

Alexander Jaust requested to merge extend-readthedocs-documentation into develop May 18, 2022

Description

This MR extends the readthedocs documentation by

Move information (structure of the repository etc) from the README to the user documentation.
Adding a description of the examples
Shortly explaining the use of the adapter

This MR is related to #7

Checklist

I made sure that the source files are formatted properly.
I added my changes to the changelog (CHANGELOG.md)
I updated the documentation.

Edited May 18, 2022 by Alexander Jaust