Automate the documentation for configuration file parameters
Currently, it takes time to maintain the documentation of all parameters accessible in the configuration file.
The purpose of this issue is to provide an automatic method to both simply add a parameter to a block and to automatically revert these changes in the documentation.
A first idea is to create a generic class allowing to initialize a block of parameters in the config file.
This class would have two methods:
get_values
: which returns a dictionary, expected by init_section
get_description
: which returns a dictionary with the parameter name and its description for documentation.
A maintenance script would be added and called at each commit to generate the corresponding rst file.
This issue would also be the opportunity to clean the block chain
that contains most of the parameters. In accordance with the design of new builders, the ideal would be that the chain
block contains only the parameters useful to a chain (output_path, firstStep, etc...).
Finally, it would also be an opportunity to harmonize the parameter names with a unique naming convention (name_param or nameParam).