GernotMaier
commented
1 month ago I built the documentation and it looks good except for some code examples which have a break line in the middle of the code. Many of the examples of the applications have this issue, which was probably there before (but this is a good moment to fix them I think):
In addition to that, I would very much like to suggest getting rid of all rst files even if we have to add an exception for the warning you mentioned. It does not look good to have all these rst files if we do not want to use rst.
This is an existing issue unrelated to this PR. Note also that most of the application descriptions do not follow the numpy doc style and needs quite some improvements. Anyway, fixed it here now.
This is a switch of the doc files in docs/sources from rst to markdown (see issue #937).
Used rst-to-msy to convert to markdown. Cross checked files (look good).
Important: No change of content. So reviewers need to confirm only the step from markdown to rst.
Note: keep 'dummy' rst files for the applications, as otherwise we get warnings about duplicated headed (as each of them have e.g., a Summary section). Changed format of the application page to allow the list of applications appear on the left side plus each application has its own page now (before: all applications were on a single page).
Add a markdownlint pre-commit.