[meta] Improve documentation of config file (#164) · Issues · dorie / dorie

[meta] Improve documentation of config file

Note: This is a meta-task. It bundles several tasks together and is only closed once all these tasks are finished.

Aims

Improve the documentation of the config file. The current documentation places the information into a badly formatted table without options for extensions.

Tasks

#165 (closed): Re-formate RST output of config file parameters
#166 (closed): Add XML tags for parameter changes by version
#167 (closed): Write version information from XML files into RST output

People involved

@lriedel

Related meta-tasks

_Note:_ This is a meta-task. It bundles several tasks together and is only closed once all these tasks are finished.

### Aims

Improve the documentation of the [config file](https://hermes.iup.uni-heidelberg.de/dorie_doc/master/html/manual/config-file.html). The current documentation places the information into a badly formatted table without options for extensions.

### Tasks
* [x] #165: Re-formate RST output of config file parameters
* [x] #166: Add XML tags for parameter changes by version
* [x] #167: Write version information from XML files into RST output

### People involved
@lriedel

### Related meta-tasks

<!--
PLEASE READ THIS

A meta task is used to organise and discuss several regular tasks.

When creating this meta task, please take care of the following:
    - When new tasks that belong to this meta-task are created,
        link them here, and add them as tasks
    - Attach the correct labels
    - Mention the people that should get involved
    - Assign the correct milestone (if available)
-->

Edited Jan 09, 2020 by Lukas Riedel

Discussion
Designs

The one place for your designs

To enable design management, you'll need to meet the requirements. If you need help, reach out to our support team for assistance.