Improve formatting of documentation, fix #49

[robertodr]

Documentation looks a bit nicer and fixes the repetitions @stigrj noticed with multiple keywords.

[stigrj]

Looks great! One more issue, though:

Long docstrings are linebreaked in the input.rst file, which leads to the following message using rst2html.py input.rst >input.html

input.rst:459: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

which also ends up in the produced html. The warning goes away if I manually unbreak these lines.

[robertodr]

How long is long? I cannot reproduce this.

[stigrj]

Hmm, turns out it line breaks at the same place that I do in the template.yml file, like this

    keywords:
      - name: numerically_exact
        type: bool
        default: false
        docstring: |
          This will use MPI algorithms that guarantees that the output is
          invariant wrt the number of MPI processes.

[robertodr]

OK, I see now!

[robertodr]

I now replace newline characters in the docstring with spaces, so the string is stitched back together. Final formatting could be a bit crappy though, as very long lines will exceed their box... I'd leave format beautification for later though.

[codecov[bot]]

Codecov Report

Merging #52 into master will increase coverage by 0.01%. The diff coverage is 100%.

[codecov[bot]]

Codecov Report

Merging #52 into master will increase coverage by 0.01%. The diff coverage is 100%.