NAME¶

votca_help2doc - Part of the VOTCA package

SYNOPSIS¶

votca_help2doc [OPTIONS]

votca_help2doc [--help]

DESCRIPTION¶

Convert a Votca CLI's help message to RST or GROFF format.

OPTIONS¶

options:

-h, --help show this help message and exit
-n NAME, --name NAME Name of the tool to extract the help message
-o OUT, --out OUT Output file
-f {rst,groff}, --format {rst,groff}
Output format
--version show program's version number and exit

AUTHORS¶

Written and maintained by the VOTCA Development Team <devs@votca.org>

COPYRIGHT¶

Copyright 2009-2021 The VOTCA Development Team (http://www.votca.org)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.