Hi,
Right now some options in the online documentation are not well rendered because sphynx does not use \n from help string. For example :
or
We can add a more usefull documentation in the doc in arguments_edit directory but maybe we should remove some information from argparse help string for some options.
Or maybe we can find a sphynx option to do it ?
Any idea ?
Thanks
I think having the top part of the docs page for a given argument match the commandline entry is incredibly valuable.
Perhaps we can edit the Sphinx theme to make it more like a codeblock or something to improve how it renders and to constrain longer lines, but my plan is to further enhance each entry using the _edit files, like how I began with things like boundary.
We also need to be mindful that any changes we make to the ODM py file render properly in the terminal for Linux/MacOS/Windows, so usage of the newline char needs to be well-tested.
What, in specific are you looking to solve? Better readability?
As a slurm (like docker or singularity), I mostly use the online documentation.
And the top part of this documentation is something really not easy to read like in cases where \n and \t are not used by sphynx
Maybe we can use this sphinx extension
Hmm 
That does look interesting.
