votca_help2doc: example section in groff out displayed correctly
Closed this issue · 1 comments
junghans commented
The csg_map
manpage generates with votca_help2doc
looks like this:
CSG_MAP(1) General Commands Manual CSG_MAP(1)
NAME
csg_map - Part of the VOTCA package
SYNOPSIS
csg_map [OPTIONS]
csg_map [--help]
DESCRIPTION
Convert a reference atomistic trajectory or configuration into a coarse-grained one based on a mapping xml-file. The mapping
can be applied to either an entire trajectory or a selected set of frames only (see options). Examples: * csg_map --top FA-
topol.tpr --trj FA-traj.trr --out CG-traj.xtc --cg cg-map.xml * csg_map --top FA-topol.tpr --trj FA-conf.gro --out CG-
conf.gro --cg cg-map.xml * csg_map --top FA-topol.tpr --trj FA-traj.xtc --out FA-history.dlph --no-map * csg_map --top FA-
field.dlpf --trj FA-history.dlph --out CG-history.dlph --cg cg-map.xml * csg_map --top .dlpf --trj .dlph --out .dlph --cg
cg-map.xml convert HISTORY to HISTORY_CGV
OPTIONS
Allowed options:
-h [ --help ] display this help and exit
--verbose be loud and noisy
--verbose1 be very loud and noisy
The examples are parts of the DESCRIPTION
and the formatting is broken.
junghans commented
There is also a problem with the examples in rst output, see here: https://www.votca.org/csg/reference.html#id4